Struct ForeignCid 

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

A CID that is not one of this crate’s two mintable profiles.

The inner Cid is private and the only constructors (new, TryFrom<Cid>, FromStr, from_bytes, Deserialize) reject a recognized profile, so a ForeignCid can never alias a ContentId or RawContentId. That is what makes ClassifiedCid canonical.

A ForeignCid can be carried, compared, linked and rendered. It cannot be minted here and never becomes a ContentId/RawContentId without re-hashing the actual content under a profile this crate does mint.

Implementations

impl ForeignCid

pub fn new(cid: Cid) -> Result<Self, ContentError>

Wrap a CID that neither mintable profile accepts.

Errors

ContentError::InvalidCidProfile if cid is a recognized profile (dag-cbor/BLAKE3 or raw/BLAKE3). Such a CID is not foreign; classify it with ClassifiedCid::from_cid, which returns the right variant.

pub fn as_cid(&self) -> &Cid

Borrow the underlying Cid.

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

The full CID binary envelope.

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

Parse a CID binary envelope that is not a recognized profile.

Errors

ContentError::InvalidCid if the bytes are not a CID; ContentError::InvalidCidProfile if they are a recognized profile.

pub fn codec(&self) -> u64

The multicodec code this foreign CID declares.

pub fn hash_code(&self) -> u64

The multihash code this foreign CID declares.

Trait Implementations

impl Clone for ForeignCid

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ForeignCid

impl Debug for ForeignCid

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ForeignCid

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Validating: a link that is a recognized profile is rejected here rather than admitted as a foreign alias.

impl Display for ForeignCid

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

Formats the value using the given formatter.

impl Eq for ForeignCid

impl From<ForeignCid> for Cid

fn from(id: ForeignCid) -> Self

Converts to this type from the input type.

impl From<ForeignCid> for ClassifiedCid

fn from(id: ForeignCid) -> Self

Converts to this type from the input type.

impl FromStr for ForeignCid

type Err = ContentError

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 ForeignCid

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 ForeignCid

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for ForeignCid

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ForeignCid

fn partial_cmp(&self, other: &Self) -> 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 ForeignCid

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ForeignCid

impl TryFrom<Cid<64>> for ForeignCid

type Error = ContentError

The type returned in the event of a conversion error.

fn try_from(cid: Cid) -> Result<Self, Self::Error>

Performs the conversion.