Skip to main content

Cid

Struct Cid 

Source
pub struct Cid { /* private fields */ }
Expand description

A content identifier.

Implementations§

Source§

impl Cid

Source

pub fn of(bytes: &[u8], alg: HashAlg) -> Self

Compute the identifier of bytes under alg.

bytes must already be canonical; this does not check that, because callers holding a decoded object have checked it already and callers holding raw input should use crate::cbor::decode first.

§Example
use publet_core::{Cid, HashAlg};

let cid = Cid::of(b"", HashAlg::Sha2_256);
assert_eq!(
    cid.to_string(),
    "pub:sha2-256:4oymiquy7qobjgx36tejs35zeqt24qpemsnzgtfeswmrw6csxbkq",
);
// The same bytes always have the same identifier.
assert_eq!(Cid::of(b"", HashAlg::Sha2_256), cid);
Source

pub fn from_digest(alg: HashAlg, digest: &[u8]) -> Option<Self>

Construct from a digest computed elsewhere.

Merkle roots are digests rather than hashes of any single byte string, so they cannot be produced by Cid::of. Returns None when the digest length does not match the algorithm.

§Example
use publet_core::{Cid, HashAlg};

let digest = HashAlg::Sha2_256.digest(b"");
let cid = Cid::from_digest(HashAlg::Sha2_256, &digest).unwrap();
assert_eq!(cid, Cid::of(b"", HashAlg::Sha2_256));

// A digest of the wrong length for the algorithm is refused.
assert_eq!(Cid::from_digest(HashAlg::Sha2_256, &digest[..31]), None);
Source

pub fn alg(&self) -> HashAlg

The algorithm this identifier uses.

§Example
use publet_core::{Cid, HashAlg};

let cid: Cid = "pub:sha2-256:4oymiquy7qobjgx36tejs35zeqt24qpemsnzgtfeswmrw6csxbkq".parse()?;
assert_eq!(cid.alg(), HashAlg::Sha2_256);
Source

pub fn digest(&self) -> &[u8] ⓘ

The raw digest.

§Example
use publet_core::{Cid, HashAlg};

let cid = Cid::of(b"", HashAlg::Sha2_256);
assert_eq!(cid.digest(), HashAlg::Sha2_256.digest(b"").as_slice());
Source

pub fn verifies(&self, bytes: &[u8]) -> bool

Whether bytes hash to this identifier.

Section 4.2 requires a recipient to verify retrieved bytes against the identifier they asked for before parsing them.

§Example
use publet_core::{Cid, HashAlg};

let cid = Cid::of(b"the bytes asked for", HashAlg::Sha2_256);
assert!(cid.verifies(b"the bytes asked for"));
// Bytes a peer substituted do not match the identifier asked for.
assert!(!cid.verifies(b"other bytes"));

Trait Implementations§

Source§

impl Clone for Cid

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Cid

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Cid

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Cid

Source§

impl FromStr for Cid

Source§

type Err = CidError

The associated error which can be returned from parsing.
Source§

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

Parses a string s to return a value of this type. Read more
Source§

impl Hash for Cid

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Cid

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Cid

Auto Trait Implementations§

§

impl Freeze for Cid

§

impl RefUnwindSafe for Cid

§

impl Send for Cid

§

impl Sync for Cid

§

impl Unpin for Cid

§

impl UnsafeUnpin for Cid

§

impl UnwindSafe for Cid

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.