pub struct Cid { /* private fields */ }Expand description
A content identifier.
Implementations§
Source§impl Cid
impl Cid
Sourcepub fn of(bytes: &[u8], alg: HashAlg) -> Self
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);Sourcepub fn from_digest(alg: HashAlg, digest: &[u8]) -> Option<Self>
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);Sourcepub fn alg(&self) -> HashAlg
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);Sourcepub fn digest(&self) -> &[u8] ⓘ
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());Sourcepub fn verifies(&self, bytes: &[u8]) -> bool
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§
impl Eq for Cid
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more