Struct TransportKey 

pub struct TransportKey(/* private fields */);

Configured transport key (e.g. "primary", "fallback").

End-user code should use Self::new or std::str::FromStr for values originating outside trusted code paths.

Implementations

impl TransportKey

pub fn new(value: impl Into<String>) -> Result<Self, StringNewtypeError>

Construct after validating the input.

Errors

Returns $crate::StringNewtypeError if the value is empty, exceeds STRING_NEWTYPE_MAX_BYTES, or contains NUL, CR/LF, or non-tab control characters.

pub fn as_str(&self) -> &str

Borrow the validated string value.

pub fn into_inner(self) -> String

Consume the newtype and return its string value.

impl TransportKey

pub fn new_unchecked(value: impl Into<String>) -> Self

Construct without validating.

Reserved for trusted inputs (e.g. internal constants in trusted code paths). Prefer Self::new or std::str::FromStr for any value that originated outside your own code.

This constructor exists only because the type was declared via the @unchecked matcher arm of [crate::string_newtype!]; the default arm omits it.

Trait Implementations

impl AsRef<str> for TransportKey

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for TransportKey

fn clone(&self) -> TransportKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransportKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TransportKey

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TransportKey

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

Formats the value using the given formatter.

impl Eq for TransportKey

impl From<TransportKey> for String

fn from(value: TransportKey) -> Self

Converts to this type from the input type.

impl FromStr for TransportKey

type Err = StringNewtypeError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for TransportKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for TransportKey

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

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

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(_generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

impl PartialEq for TransportKey

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TransportKey

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 TransportKey

impl TryFrom<&str> for TransportKey

type Error = StringNewtypeError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for TransportKey

type Error = StringNewtypeError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.