Struct ShardId

pub struct ShardId(pub(crate) [u8; 16]);

An opaque identifier for a persist durable TVC (aka shard).

The std::string::ToString::to_string format of this may be stored durably or otherwise used as an interchange format. It can be parsed back using str::parse or std::str::FromStr::from_str.

Tuple Fields

0: [u8; 16]

Implementations

impl ShardId

pub fn new() -> Self

Returns a random ShardId that is reasonably likely to have never been generated before.

Trait Implementations

impl Arbitrary for ShardId

type Parameters = <[u8; 16] as Arbitrary>::Parameters

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = Map<<[u8; 16] as Arbitrary>::Strategy, fn(_: [u8; 16]) -> ShardId>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_top: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for ShardId

fn clone(&self) -> ShardId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Codec for ShardId

type Storage = ()

A type used with Self::decode_from for allocation reuse. Set to () if unnecessary.

type Schema = ShardIdSchema

The type of the associated schema for Self.

fn codec_name() -> String

Name of the codec.

fn encode<B: BufMut>(&self, buf: &mut B)

Encode a key or value for permanent storage.

fn decode<'a>(buf: &'a [u8], _schema: &ShardIdSchema) -> Result<Self, String>

Decode a key or value previous encoded with this codec’s Codec::encode.

fn encode_schema(_schema: &Self::Schema) -> Bytes

Encode a schema for permanent storage.

fn decode_schema(buf: &Bytes) -> Self::Schema

Decode a schema previous encoded with this codec’s Self::encode_schema.

fn encode_to_vec(&self) -> Vec<u8>

Encode a key or value to a Vec.

fn decode_from<'a>( &mut self, buf: &'a [u8], _storage: &mut Option<Self::Storage>, schema: &Self::Schema, ) -> Result<(), String>

An alternate form of Self::decode which enables amortizing allocs.

fn validate(_val: &Self, _schema: &Self::Schema) -> Result<(), String>

Checks that the given value matches the provided schema.

impl Debug for ShardId

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

Formats the value using the given formatter.

impl Default for ShardId

fn default() -> ShardId

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ShardId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ShardId

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

Formats the value using the given formatter.

impl From<ShardId> for String

fn from(shard_id: ShardId) -> Self

Converts to this type from the input type.

impl FromStr for ShardId

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ShardId

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 Ord for ShardId

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

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

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

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

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

impl PartialOrd for ShardId

fn partial_cmp(&self, other: &ShardId) -> 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 RustType<String> for ShardId

fn into_proto(&self) -> String

Convert a Self into a Proto value.

fn from_proto(proto: String) -> Result<Self, TryFromProtoError>

Consume and convert a Proto back into a Self value.

fn into_proto_owned(self) -> Proto

A zero clone version of Self::into_proto that types can optionally implement, otherwise, the default implementation delegates to Self::into_proto.

impl Schema<ShardId> for ShardIdSchema

type ArrowColumn = GenericByteArray<GenericStringType<i32>>

The type of column we decode from, and encoder will finish into.

type Statistics = NoneStats

Statistics we collect for a schema of this type.

type Decoder = SimpleColumnarDecoder<ShardId>

Type that is able to decode values of T from Self::ArrowColumn.

type Encoder = SimpleColumnarEncoder<ShardId>

Type that is able to encoder values of T.

fn encoder(&self) -> Result<Self::Encoder, Error>

Returns a type that can encode values of T.

fn decoder(&self, col: Self::ArrowColumn) -> Result<Self::Decoder, Error>

Returns a type that is able to decode instances of T from the provider column.

fn decoder_any(&self, col: &dyn Array) -> Result<Self::Decoder, Error>

Returns a type that is able to decode instances of T from a type erased arrow::array::Array, erroring if the provided array is not Self::ArrowColumn.

impl Serialize for ShardId

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SimpleColumnarData for ShardId

type ArrowBuilder = GenericByteBuilder<GenericStringType<i32>>

Type of arrow builder that we encode data into.

type ArrowColumn = GenericByteArray<GenericStringType<i32>>

Type of arrow array the we decode data from.

fn goodbytes(builder: &Self::ArrowBuilder) -> usize

The number of actual data bytes this item represents.

fn push(&self, builder: &mut Self::ArrowBuilder)

Encode self into builder.

fn push_null(builder: &mut Self::ArrowBuilder)

Encode a null value into builder.

fn read(&mut self, idx: usize, column: &Self::ArrowColumn)

Decode an instance of self from column.

impl TryFrom<String> for ShardId

type Error = String

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for ShardId

impl Eq for ShardId

impl StructuralPartialEq for ShardId