Struct ValueData 

pub struct ValueData { /* private fields */ }

A DHT value and its metadata

Implementations

impl ValueData

pub const MAX_LEN: usize = 32768

Maximum length in bytes of the data a single subkey may hold

pub fn new<B: Into<Bytes>>(data: B, writer: PublicKey) -> VeilidAPIResult<Self>

Make a new value with sequence number ValueSeqNum::ZERO. Fails if data exceeds ValueData::MAX_LEN.

Errors with VeilidAPIError::Generic if data exceeds ValueData::MAX_LEN.

pub fn new_with_seq<B: Into<Bytes>>( seq: ValueSeqNum, data: B, writer: PublicKey, ) -> VeilidAPIResult<Self>

Make a new value with an explicit sequence number. Fails if seq is ValueSeqNum::NONE or data exceeds ValueData::MAX_LEN.

Errors with VeilidAPIError::Generic if seq is ValueSeqNum::NONE or data exceeds ValueData::MAX_LEN.

pub fn ref_writer(&self) -> &PublicKey

The public identity key of the writer of the data, by reference

pub fn data(&self) -> &[u8]

The stored bytes

pub fn data_bytes(&self) -> Bytes

The stored bytes as an owned Bytes

pub fn seq(&self) -> ValueSeqNum

The sequence number ordering this value among changes to the same subkey

pub fn writer(&self) -> PublicKey

The public identity key of the writer of the data

pub fn data_size(&self) -> usize

The length in bytes of the stored data

pub fn total_size(&self) -> usize

The in-memory footprint of this value, including the struct itself and its data

Trait Implementations

impl Clone for ValueData

fn clone(&self) -> ValueData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValueData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ValueData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ValueData

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

Formats the value using the given formatter.

impl Eq for ValueData

impl Ord for ValueData

fn cmp(&self, other: &ValueData) -> 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 PartialEq for ValueData

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ValueData

fn partial_cmp(&self, other: &ValueData) -> 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 Serialize for ValueData

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 ValueData