Struct Slice 

pub struct Slice<I, R: ?Sized = [u8]> { /* private fields */ }

A borrowed, dynamically sized key that satisfies an Invariant.

Implementations

impl<I, R> Slice<I, R>

where I: Invariant, R: ?Sized + Raw,

pub fn new(key: &R) -> Result<&Self, I::Error>

Construct a slice after validating.

Returns Ok if the input key satisfies the invariant.

impl<I, R: ?Sized> Slice<I, R>

pub const unsafe fn new_unchecked(key: &R) -> &Self

Safety

Caller must ensure key upholds invariants, i.e., I::validate(key) would return Ok.

impl<I> Slice<I, str>

pub const fn as_str(&self) -> &str

Get a reference to the underlying str.

impl<I> Slice<I, [u8]>

pub const fn as_bytes(&self) -> &[u8]

Get a reference to the underlying [u8].

Trait Implementations

impl<I, R: ?Sized> AsRef<R> for Slice<I, R>

fn as_ref(&self) -> &R

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

impl<I, R: ?Sized> AsRef<Slice<I, R>> for BoxedSlice<I, R>

fn as_ref(&self) -> &Slice<I, R>

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

impl<I, R: ?Sized> Borrow<Slice<I, R>> for BoxedSlice<I, R>

fn borrow(&self) -> &Slice<I, R>

Immutably borrows from an owned value.

impl<I: Debug, R: Debug + ?Sized> Debug for Slice<I, R>

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

Formats the value using the given formatter.

impl<I: Eq, R: Eq + ?Sized> Eq for Slice<I, R>

impl<'a> From<&'a CStr> for &'a Slice<Terminated<0>, [u8]>

fn from(str: &'a CStr) -> Self

Converts to this type from the input type.

impl<I: Hash, R: Hash + ?Sized> Hash for Slice<I, R>

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, I, R> Key for &'a Slice<I, R>

where I: Invariant, R: ?Sized + Raw,

type Borrowed = Slice<I, R>

A non-allocated byte sequence that a key can be cheaply borrowed as.

type Insert<'k> = &'a Slice<I, R> where Self: 'k

Keys can either have edges that store inline bytes (e.g., u64, BoxedSlice), or pointers (i.e., Slice).

type Read<'k> = Reader<'k, <I as Invariant>::Terminate>

Tracks key length and allows extracting edges and slicing key bytes.

type Write = Writer<I>

Constructs a key from an initial reader prefix and sequence of bytes and edges.

type Edge = Slice<<I as Invariant>::Terminate>

Edge metadata.

type Len = Byte

Key length.

fn as_insert(&self) -> Self::Insert<'_>

Convert the key type to the insert type.

fn insert_as_read<'k>(insert: Self::Insert<'k>) -> Self::Read<'k>

where Self: 'k,

Convert the insert type to a reader with appropriate lifetime.

fn insert_to_key<'k>(insert: Self::Insert<'k>) -> Self

where Self: 'k,

Convert the insert type to the key type.

unsafe fn write_as_insert<'k>(writer: &'k Self::Write) -> Self::Insert<'k>

where Self: 'k,

Convert a reference to a writer into the insert type.

impl<I: Ord, R: Ord + ?Sized> Ord for Slice<I, R>

fn cmp(&self, other: &Slice<I, R>) -> 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<I: PartialEq, R: PartialEq + ?Sized> PartialEq for Slice<I, R>

fn eq(&self, other: &Slice<I, R>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<I: PartialOrd, R: PartialOrd + ?Sized> PartialOrd for Slice<I, R>

fn partial_cmp(&self, other: &Slice<I, R>) -> 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<I: PartialEq, R: PartialEq + ?Sized> StructuralPartialEq for Slice<I, R>

impl<I, R> ToOwned for Slice<I, R>

where R: ?Sized + Raw,

type Owned = BoxedSlice<I, R>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.