Skip to content

chore: update ntex-cors doc to use http::Method instead of &str #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 1, 2025
Merged

chore: update ntex-cors doc to use http::Method instead of &str #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions ntex-cors/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
//! .wrap(
//! Cors::new() // <- Construct CORS middleware builder
//! .allowed_origin("https://www.rust-lang.org/")
//! .allowed_methods(vec!["GET", "POST"])
//! .allowed_methods(vec![http::Method::GET, http::Method::POST])
//! .allowed_headers(vec![http::header::AUTHORIZATION, http::header::ACCEPT])
//! .allowed_header(http::header::CONTENT_TYPE)
//! .max_age(3600)
Expand Down Expand Up @@ -259,7 +259,18 @@ impl Cors {
/// This is the `list of methods` in the
/// [Resource Processing Model](https://www.w3.org/TR/cors/#resource-processing-model).
///
/// Defaults to `[GET, HEAD, POST, OPTIONS, PUT, PATCH, DELETE]`
/// You can use either `&str` (e.g. `"GET"`) or directly use the [`http::Method`] enum
/// (e.g. `http::Method::GET`). Using [`http::Method`] is recommended for better type safety
/// and to avoid runtime errors due to typos.
///
/// # Example
/// ```rust
/// use ntex::http::Method;
///
/// cors.allowed_methods(vec![Method::GET, Method::POST]);
/// ```
///
/// The default is `[GET, HEAD, POST, OPTIONS, PUT, PATCH, DELETE]`.
pub fn allowed_methods<U, M>(mut self, methods: U) -> Self
where
U: IntoIterator<Item = M>,
Expand Down
Loading