Struct Origin 

pub struct Origin {
    pub hostname: String,
    pub port: u16,
    pub protocol: Protocol,
    pub path: String,
    pub cookie_secure: Option<bool>,
}

Fields

hostname: String

External hostname for URLs

port: u16

External port for URLs

protocol: Protocol

Protocol (http or https)

path: String

URL path prefix

cookie_secure: Option<bool>

Force the Secure flag on cookies (true) or never set it (false). Unset, cookies are secure only when protocol is https. Set it to true when Kellnr is reached over https through a TLS-terminating proxy but protocol is http

Implementations

impl Origin

pub fn secure_cookies(&self) -> bool

Whether cookies must carry the Secure flag.

pub fn path_prefix(&self) -> UrlPathPrefix

The URL path below which Kellnr is served.

pub fn normalize(&mut self)

Brings path into the form of UrlPathPrefix. Applied once when the settings are loaded, so the settings show the path in use.

pub fn base_url(&self) -> String

External URL of Kellnr without a trailing slash. The port is left out if it is the default port of the protocol.

Trait Implementations

impl Clone for Origin

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for Origin

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for Origin

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

Formats the value using the given formatter.

impl Default for Origin

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Origin

where Origin: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Origin

impl PartialEq for Origin

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Origin

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Origin

impl ToSchema for Origin

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.