Struct kvstructs::ValueRef

source · [−]

pub struct ValueRef<'a> { /* private fields */ }

Expand description

ValueRef contains a &'a Value

Implementations

source

impl<'a> ValueRef<'a>

source

pub const fn new(
    meta: u8,
    user_meta: u8,
    expires_at: u64,
    version: u64,
    data: &'a [u8]
) -> Self

Returns a ValueRef from byte slice

source

pub unsafe fn from_raw_value_pointer(rp: RawValuePointer) -> ValueRef<'a>

Returns a ValueRef from RawKeyPointer

Safety

The inner raw pointer of RawKeyPointer must be valid.

source

pub fn to_string(&self) -> String

Converts a slice of bytes to a string, including invalid characters.

source

pub fn to_lossy_string(&self) -> Cow<'_, str>

Converts a slice of bytes to a string, including invalid characters.

source

pub fn to_value(&self) -> Value

Copy the data to a new value

source

pub fn get_version(&self) -> u64

Get the value version

Trait Implementations

source

impl<'a> Clone for ValueRef<'a>

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<'a> Debug for ValueRef<'a>

source

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

Formats the value using the given formatter. Read more

source

impl<'a> PartialEq<ValueRef<'a>> for ValueRef<'a>

source

fn eq(&self, other: &ValueRef<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

source

fn ne(&self, other: &ValueRef<'a>) -> bool

This method tests for !=.

source

impl<'a> ValueExt for ValueRef<'a>

source

fn as_value_ref(&self) -> ValueRef<'_>

Returns a ValueRef Read more

source

fn parse_value(&self) -> &[u8]ⓘNotable traits for &[u8]`impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]`

Returns the value data

source

fn parse_value_to_bytes(&self) -> Bytes

Returns the value data, shallow copy

source

fn get_meta(&self) -> u8

Get the meta of the value

source

fn get_user_meta(&self) -> u8

Get the user meta

source

fn get_expires_at(&self) -> u64

Returns the expiration time (unix timestamp) for this value

source

fn encoded_size(&self) -> u32

Returns the size of the Value when encoded

source

fn encode(&self, buf: &mut [u8])

Encode to a mutable slice. This function will copy the value. Use to_encoded, if you want a shallow copy when encoded. Read more

source

fn to_encoded(&self) -> EncodedValue

Encode to EncodedValue. Read more

source

fn decode_value_ref(src: &[u8]) -> ValueRef<'_>

Decodes byte slice to value ref.

source

fn decode_value(src: &[u8]) -> Value

Decodes byte slice to value.

source

fn decode_bytes(src: Bytes) -> Value

Decode bytes to value. (Shallow copy)

source

fn has_prefix(&self, prefix: impl ValueExt) -> bool

Returns whether the slice self begins with prefix.

source

fn has_suffix(&self, suffix: impl ValueExt) -> bool

Returns whether the slice self ends with suffix.

source

fn longest_prefix(&self, other: impl ValueExt) -> &[u8]ⓘNotable traits for &[u8]`impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]`

Finds the longest shared prefix

source

fn longest_suffix(&self, other: impl ValueExt) -> &[u8]ⓘNotable traits for &[u8]`impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]`

Finds the longest shared suffix

source

fn longest_prefix_lossy(&self, other: impl ValueExt) -> Cow<'_, [u8]>

Finds the longest shared prefix, return a Cow<’_, u8>.

source

fn longest_suffix_lossy(&self, other: impl ValueExt) -> Cow<'_, [u8]>

Finds the longest shared suffix, return a Cow<’_, u8>.

source

impl<'a> StructuralPartialEq for ValueRef<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for ValueRef<'a>

impl<'a> Send for ValueRef<'a>

impl<'a> Sync for ValueRef<'a>

impl<'a> Unpin for ValueRef<'a>

impl<'a> UnwindSafe for ValueRef<'a>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

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

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct kvstructs::ValueRef

Implementations

impl<'a> ValueRef<'a>

pub const fn new( meta: u8, user_meta: u8, expires_at: u64, version: u64, data: &'a [u8]) -> Self

pub unsafe fn from_raw_value_pointer(rp: RawValuePointer) -> ValueRef<'a>

Safety

pub fn to_string(&self) -> String

pub fn to_lossy_string(&self) -> Cow<'_, str>

pub fn to_value(&self) -> Value

pub fn get_version(&self) -> u64

Trait Implementations

impl<'a> Clone for ValueRef<'a>

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

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

impl<'a> Debug for ValueRef<'a>

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

impl<'a> PartialEq<ValueRef<'a>> for ValueRef<'a>

fn eq(&self, other: &ValueRef<'a>) -> bool

fn ne(&self, other: &ValueRef<'a>) -> bool

impl<'a> ValueExt for ValueRef<'a>

fn as_value_ref(&self) -> ValueRef<'_>

fn parse_value(&self) -> &[u8]ⓘNotable traits for &[u8]impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]

fn parse_value_to_bytes(&self) -> Bytes

fn get_meta(&self) -> u8

fn get_user_meta(&self) -> u8

fn get_expires_at(&self) -> u64

fn encoded_size(&self) -> u32

fn encode(&self, buf: &mut [u8])

fn to_encoded(&self) -> EncodedValue

fn decode_value_ref(src: &[u8]) -> ValueRef<'_>

fn decode_value(src: &[u8]) -> Value

fn decode_bytes(src: Bytes) -> Value

fn has_prefix(&self, prefix: impl ValueExt) -> bool

fn has_suffix(&self, suffix: impl ValueExt) -> bool

fn longest_prefix(&self, other: impl ValueExt) -> &[u8]ⓘNotable traits for &[u8]impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]

fn longest_suffix(&self, other: impl ValueExt) -> &[u8]ⓘNotable traits for &[u8]impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]

fn longest_prefix_lossy(&self, other: impl ValueExt) -> Cow<'_, [u8]>

fn longest_suffix_lossy(&self, other: impl ValueExt) -> Cow<'_, [u8]>

impl<'a> Copy for ValueRef<'a>

impl<'a> Eq for ValueRef<'a>

impl<'a> StructuralEq for ValueRef<'a>

impl<'a> StructuralPartialEq for ValueRef<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for ValueRef<'a>

impl<'a> Send for ValueRef<'a>

impl<'a> Sync for ValueRef<'a>

impl<'a> Unpin for ValueRef<'a>

impl<'a> UnwindSafe for ValueRef<'a>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub const fn new(
meta: u8,
user_meta: u8,
expires_at: u64,
version: u64,
data: &'a [u8]
) -> Self

fn parse_value(&self) -> &[u8]ⓘNotable traits for &[u8]`impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]`

fn longest_prefix(&self, other: impl ValueExt) -> &[u8]ⓘNotable traits for &[u8]`impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]`

fn longest_suffix(&self, other: impl ValueExt) -> &[u8]ⓘNotable traits for &[u8]`impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]`

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,