Struct ShortString 

pub struct ShortString;

A inline encoding for a short string. A short string is a UTF-8 encoded string with a maximum length of 32 bytes (inclusive) The string is null-terminated. If the string is shorter than 32 bytes, the remaining bytes are zero. If the string is exactly 32 bytes, then there is no zero terminator.

Trait Implementations

impl Encodes<&String> for ShortString

type Output = Inline<ShortString>

The concrete form this source produces when encoded for this schema. Inline<Self> for inline encodings, Blob<Self> for blob encodings, or Inline<Handle<Self>> for the precomputed-handle case where Self: BlobEncoding.

fn encode(source: &String) -> Inline<ShortString>

Run the encoding.

impl Encodes<&str> for ShortString

type Output = Inline<ShortString>

The concrete form this source produces when encoded for this schema. Inline<Self> for inline encodings, Blob<Self> for blob encodings, or Inline<Handle<Self>> for the precomputed-handle case where Self: BlobEncoding.

fn encode(source: &str) -> Inline<ShortString>

Run the encoding.

impl Encodes<String> for ShortString

type Output = Inline<ShortString>

The concrete form this source produces when encoded for this schema. Inline<Self> for inline encodings, Blob<Self> for blob encodings, or Inline<Handle<Self>> for the precomputed-handle case where Self: BlobEncoding.

fn encode(source: String) -> Inline<ShortString>

Run the encoding.

impl InlineEncoding for ShortString

type ValidationError = ValidationError

The error type returned by validate. Use () or Infallible when every bit pattern is valid.

type Encoding = ShortString

The trait parameter to dispatch via for entity!{} field conversion. For inline schemas (32-byte data lives in the trible), set Encoding = Self — sources convert via IntoEncoded<Self> { Output = Inline<Self> }. For Handle<T>, set Encoding = T — sources convert via IntoEncoded<T> { Output = Blob<T> }. The BlobEncoding T sitting directly at trait position 0 is what lets downstream impl IntoEncoded<MyBlob> for MyType without bumping into the orphan rule.

fn validate(value: Inline<Self>) -> Result<Inline<Self>, Self::ValidationError>

Check if the given value conforms to this schema.

fn inline_from<T: IntoInline<Self>>(t: T) -> Inline<Self>

Create a new value from a concrete Rust type via IntoInline. Panics if the underlying conversion panics.

fn inline_try_from<T: TryToInline<Self>>( t: T, ) -> Result<Inline<Self>, <T as TryToInline<Self>>::Error>

Create a new value from a concrete Rust type via TryToInline. Returns an error if the conversion fails.

fn to_encoded(form: Inline<Self>) -> Encoded<Self>

Lift an already-encoded Inline<Self> into the Encoded sum entity!{} consumes — yields Encoded::Inline(form), no side-blob.

impl MetaDescribe for ShortString

fn describe() -> Fragment

Produces a Fragment describing this schema type.

fn id() -> Id

Returns the id of this type. Default: derive from Self::describe().root(). Impls choose whether the id is explicit (an entity!{ &id_hex @ … } form inside describe) or derived (no @, intrinsic id from the facts) — either way the default reads the root the fragment carries.

impl<'a> TryFromInline<'a, ShortString> for &'a str

type Error = Utf8Error

The error type returned when the conversion fails.

fn try_from_inline(v: &'a Inline<ShortString>) -> Result<&'a str, Self::Error>

Convert the Inline with a specific schema type to the Rust type.

impl<'a> TryFromInline<'a, ShortString> for String

type Error = Utf8Error

The error type returned when the conversion fails.

fn try_from_inline(v: &Inline<ShortString>) -> Result<Self, Self::Error>

Convert the Inline with a specific schema type to the Rust type.

impl TryToInline<ShortString> for &str

type Error = FromStrError

The error type returned when the conversion fails.

fn try_to_inline(self) -> Result<Inline<ShortString>, Self::Error>

Convert the Rust type to a Inline with a specific schema type.

impl TryToInline<ShortString> for String

type Error = FromStrError

The error type returned when the conversion fails.

fn try_to_inline(self) -> Result<Inline<ShortString>, Self::Error>

Convert the Rust type to a Inline with a specific schema type.