Struct VoidCid 

pub struct VoidCid(/* private fields */);

A content identifier for void objects.

Wraps cid::Cid with void-specific constructors, validation, and a Display implementation so CIDs can be used directly in format strings without calling a separate to_string() helper.

All void CIDs are CIDv1 with raw codec (0x55) and SHA-256 multihash.

Implementations

impl VoidCid

pub fn create(data: &[u8]) -> Self

Creates a CIDv1 from raw bytes using SHA-256.

pub fn parse(s: &str) -> Result<Self>

Parses a CID from its string representation.

pub fn from_bytes(bytes: &[u8]) -> Result<Self>

Parses a CID from raw bytes.

pub fn to_bytes(&self) -> Vec<u8>

Converts to the byte representation.

pub fn validate(&self) -> Result<()>

Validates that this CID uses void’s canonical format (CIDv1/raw/SHA-256).

pub fn inner(&self) -> &Cid

Returns the inner cid::Cid.

Methods from Deref<Target = Cid>

pub fn version(&self) -> Version

Returns the cid version.

pub fn codec(&self) -> u64

Returns the cid codec.

pub fn hash(&self) -> &Multihash<S>

Returns the cid multihash.

pub fn write_bytes<W>(&self, w: W) -> Result<usize, Error>

where W: Write,

Writes the bytes to a byte stream, returns the number of bytes written.

pub fn encoded_len(&self) -> usize

Returns the length in bytes needed to encode this cid into bytes.

pub fn to_bytes(&self) -> Vec<u8>

Returns the encoded bytes of the Cid.

pub fn to_string_of_base(&self, base: Base) -> Result<String, Error>

Convert CID into a multibase encoded string

Example

use cid::Cid;
use multibase::Base;
use multihash_codetable::{Code, MultihashDigest};

const RAW: u64 = 0x55;

let cid = Cid::new_v1(RAW, Code::Sha2_256.digest(b"foo"));
let encoded = cid.to_string_of_base(Base::Base64).unwrap();
assert_eq!(encoded, "mAVUSICwmtGto/8aP+ZtFPB0wQTQTQi1wZIO/oPmKXohiZueu");

Trait Implementations

impl Clone for VoidCid

fn clone(&self) -> VoidCid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VoidCid

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

Formats the value using the given formatter.

impl Deref for VoidCid

type Target = Cid<64>

The resulting type after dereferencing.

fn deref(&self) -> &Cid

Dereferences the value.

impl Display for VoidCid

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

Formats the value using the given formatter.

impl From<Cid<64>> for VoidCid

fn from(cid: Cid) -> Self

Converts to this type from the input type.

impl From<VoidCid> for Cid

fn from(vcid: VoidCid) -> Cid

Converts to this type from the input type.

impl Hash for VoidCid

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 VoidCid

fn cmp(&self, other: &VoidCid) -> 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<Cid<64>> for VoidCid

fn eq(&self, other: &Cid) -> 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 PartialEq<VoidCid> for Cid

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

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

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

impl Eq for VoidCid

impl StructuralPartialEq for VoidCid