Struct Strand 

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

A Strand represents the metadata for the chain of Tixels

A Strand is verified for integrity and authenticity via the CID and public key it contains.

The most common way to obtain a Strand will be from a crate::twine::Twine, a crate::resolver::Resolver, or using Strand::from_tagged_dag_json or Strand::from_block.

A Strand contains an Arc to its underlying data, so it is efficient to clone and pass around.

See also

• Tixel
• crate::twine::Twine

Implementations

impl Strand

pub fn try_new<C>(container: C) -> Result<Self, VerificationError>

where C: TryInto<StrandSchemaVersion>, VerificationError: From<<C as TryInto<StrandSchemaVersion>>::Error>,

Create a new Strand from its underlying data

It is uncommon to use this directly.

pub fn cid(&self) -> Cid

Get the CID of the Strand

pub fn key(&self) -> PublicKey

Get the public key of the Strand

pub fn radix(&self) -> u8

Get the radix value of the skiplist

pub fn spec_str(&self) -> &str

Get the spec string of the Strand

pub fn version(&self) -> Version

Get the twine version of this record

pub fn subspec(&self) -> Option<Subspec>

Get the subspec of this record if it exists

pub fn details(&self) -> &Ipld

Get the details of the Strand

Details describe the Strand in a human-readable way and can contain any data, usually described by the subspec.

pub fn extract_details<T: DeserializeOwned>( &self, ) -> Result<T, VerificationError>

Deserialize the details as a specific type

pub fn expiry(&self) -> Option<DateTime<Utc>>

Get the expiry date of the Strand

pub fn verify_tixel(&self, tixel: &Tixel) -> Result<(), VerificationError>

Verify a Tixel using this Strand’s public key

pub fn hasher(&self) -> Code

Get the hasher (Code) used to compute the CID

Trait Implementations

impl AsCid for Strand

fn as_cid(&self) -> &Cid

Get the CID as a reference

impl Clone for Strand

fn clone(&self) -> Strand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Strand

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

Formats the value using the given formatter.

impl Display for Strand

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

Formats the value using the given formatter.

impl From<Strand> for AnyTwine

fn from(s: Strand) -> Self

Converts to this type from the input type.

impl From<Strand> for Cid

fn from(t: Strand) -> Self

Converts to this type from the input type.

impl From<Strand> for SingleQuery

fn from(strand: Strand) -> Self

Converts to this type from the input type.

impl From<StrandResolution> for Strand

fn from(resolution: StrandResolution) -> Self

Converts to this type from the input type.

impl Hash for Strand

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 PartialEq<AnyTwine> for Strand

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

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

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

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

fn eq(&self, other: &Strand) -> 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 TryFrom<AnyTwine> for Strand

type Error = VerificationError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TwineBlock for Strand

fn cid(&self) -> &Cid

Get the CID

fn from_tagged_dag_json<S: Display>(json: S) -> Result<Self, VerificationError>

Decode from DAG-JSON

fn from_bytes_unchecked( hasher: Code, bytes: Vec<u8>, ) -> Result<Self, VerificationError>

Decode from raw bytes without checking CID

fn from_block<T: AsRef<[u8]>>( cid: Cid, bytes: T, ) -> Result<Self, VerificationError>

Decode from a Block

fn tagged_dag_json(&self) -> String

Encode a Tagged version to DAG-JSON

fn bytes(&self) -> Arc<[u8]>

Encode to raw bytes

fn content_bytes(&self) -> Arc<[u8]>

The serialized bytes of the content field

fn tagged_dag_json_pretty(&self) -> String

Encode a Tagged version to pretty dag-json

fn verify_cid(&self, expected: &Cid) -> Result<(), VerificationError>

Verify the CID against the expected CID

fn hasher(&self) -> Code

Get the hasher (Code) for this data structure

fn content_hash(&self) -> Multihash

Get the hash of the content field

impl Eq for Strand

impl StructuralPartialEq for Strand