Struct TempestStr 

pub struct TempestStr<'a>(/* private fields */);

A validated, potentially borrowed string for use as a Tempest identifier (database name, table name, etc.).

Null bytes are rejected at construction time, since they are reserved as terminators in the lexical key encoding scheme. This keeps the encoding layer simple - identifier components can be written as raw bytes with no escaping required.

Borrows the input when possible (Cow::Borrowed) to avoid unnecessary allocations. Use into_owned to promote to a 'static lifetime.

Implementations

impl<'a> TempestStr<'a>

pub fn from_borrowed(s: &'a str) -> Result<TempestStr<'a>, TempestStrError>

Constructs a TempestStr borrowing from s.

Errors

Returns TempestStrError::InputContainsNullByte if s contains a null byte.

pub const unsafe fn from_borrowed_unchecked(s: &'a str) -> TempestStr<'a>

Constructs a TempestStr borrowing from s.

Safety

The caller must ensure that s does not contain any null byte.

pub fn from_owned(s: String) -> Result<TempestStr<'static>, TempestStrError>

Constructs a TempestStr from an owned String, yielding a 'static lifetime.

Errors

Returns TempestStrError::InputContainsNullByte if s contains a null byte.

pub fn into_owned(self) -> TempestStr<'static>

Converts this TempestStr into an owned 'static version, allocating if the inner value is currently borrowed. No-op if it is already owned.

Trait Implementations

impl<'a> Clone for TempestStr<'a>

fn clone(&self) -> TempestStr<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for TempestStr<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for TempestStr<'a>

type Target = Cow<'a, str>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de, 'a> Deserialize<'de> for TempestStr<'a>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> Display for TempestStr<'a>

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

Formats the value using the given formatter.

impl From<&'static str> for TempestStr<'static>

fn from(s: &'static str) -> Self

Converts to this type from the input type.

impl From<u32> for TempestStr<'static>

fn from(value: u32) -> Self

Converts to this type from the input type.

impl<'a> Hash for TempestStr<'a>

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<'a> Ord for TempestStr<'a>

fn cmp(&self, other: &TempestStr<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for TempestStr<'a>

where Cow<'a, str>: PartialEq,

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

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

fn ne(&self, __other: &Self) -> bool

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

impl<'a> PartialOrd for TempestStr<'a>

fn partial_cmp(&self, other: &TempestStr<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Serialize for TempestStr<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<String> for TempestStr<'static>

type Error = TempestStrError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> Eq for TempestStr<'a>

where Self: PartialEq, Cow<'a, str>: Eq,