Struct UrlMap 

#[non_exhaustive]
pub struct UrlMap {
    pub url_regex: String,
    pub security_level: SecurityLevel,
    pub login: LoginRequirement,
    pub auth_fail_action: AuthFailAction,
    pub redirect_http_response_code: RedirectHttpResponseCode,
    pub handler_type: Option<HandlerType>,
    /* private fields */
}

URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

url_regex: String

URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.

security_level: SecurityLevel

Security (HTTPS) enforcement for this URL.

login: LoginRequirement

Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.

auth_fail_action: AuthFailAction

Action to take when users access resources that require authentication. Defaults to redirect.

redirect_http_response_code: RedirectHttpResponseCode

30x code to use when performing redirects for the secure field. Defaults to 302.

handler_type: Option<HandlerType>

Type of handler for this URL pattern.

Implementations

impl UrlMap

pub fn new() -> Self

pub fn set_url_regex<T: Into<String>>(self, v: T) -> Self

Sets the value of url_regex.

pub fn set_security_level<T: Into<SecurityLevel>>(self, v: T) -> Self

Sets the value of security_level.

pub fn set_login<T: Into<LoginRequirement>>(self, v: T) -> Self

Sets the value of login.

pub fn set_auth_fail_action<T: Into<AuthFailAction>>(self, v: T) -> Self

Sets the value of auth_fail_action.

pub fn set_redirect_http_response_code<T: Into<RedirectHttpResponseCode>>( self, v: T, ) -> Self

Sets the value of redirect_http_response_code.

pub fn set_handler_type<T: Into<Option<HandlerType>>>(self, v: T) -> Self

Sets the value of handler_type.

Note that all the setters affecting handler_type are mutually exclusive.

pub fn static_files(&self) -> Option<&Box<StaticFilesHandler>>

The value of handler_type if it holds a StaticFiles, None if the field is not set or holds a different branch.

pub fn set_static_files<T: Into<Box<StaticFilesHandler>>>(self, v: T) -> Self

Sets the value of handler_type to hold a StaticFiles.

Note that all the setters affecting handler_type are mutually exclusive.

pub fn script(&self) -> Option<&Box<ScriptHandler>>

The value of handler_type if it holds a Script, None if the field is not set or holds a different branch.

pub fn set_script<T: Into<Box<ScriptHandler>>>(self, v: T) -> Self

Sets the value of handler_type to hold a Script.

Note that all the setters affecting handler_type are mutually exclusive.

pub fn api_endpoint(&self) -> Option<&Box<ApiEndpointHandler>>

The value of handler_type if it holds a ApiEndpoint, None if the field is not set or holds a different branch.

pub fn set_api_endpoint<T: Into<Box<ApiEndpointHandler>>>(self, v: T) -> Self

Sets the value of handler_type to hold a ApiEndpoint.

Note that all the setters affecting handler_type are mutually exclusive.

Trait Implementations

impl Clone for UrlMap

fn clone(&self) -> UrlMap

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UrlMap

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for UrlMap

fn default() -> UrlMap

Returns the “default value” for a type.

impl Message for UrlMap

fn typename() -> &'static str

The typename of this message.

impl PartialEq for UrlMap

fn eq(&self, other: &UrlMap) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UrlMap