Struct ipfs_embed::Block

pub struct Block<S> { /* private fields */ }

Block

Implementations

impl<S> Block<S>where
    S: StoreParams,

pub fn new(cid: Cid<64>, data: Vec<u8, Global>) -> Result<Block<S>, Error>

Creates a new block. Returns an error if the hash doesn’t match the data.

pub fn new_unchecked(cid: Cid<64>, data: Vec<u8, Global>) -> Block<S>

Creates a new block without verifying the cid.

pub fn cid(&self) -> &Cid<64>

Returns the cid.

pub fn data(&self) -> &[u8]

Returns the payload.

pub fn into_inner(self) -> (Cid<64>, Vec<u8, Global>)

Returns the inner cid and data.

pub fn encode<CE, T>(
    codec: CE,
    hcode: <S as StoreParams>::Hashes,
    payload: &T
) -> Result<Block<S>, Error>where
    CE: Codec + Into<<S as StoreParams>::Codecs>,
    T: Encode<CE> + ?Sized,

Encode a block.`

pub fn decode<CD, T>(&self) -> Result<T, Error>where
    CD: Codec,
    T: Decode<CD>,
    <S as StoreParams>::Codecs: Into<CD>,

Decodes a block.

Example

Decoding to [Ipld]:

use libipld::block::Block;
use libipld::cbor::DagCborCodec;
use libipld::ipld::Ipld;
use libipld::multihash::Code;
use libipld::store::DefaultParams;

let block =
    Block::<DefaultParams>::encode(DagCborCodec, Code::Blake3_256, "Hello World!").unwrap();
let ipld = block.decode::<DagCborCodec, Ipld>().unwrap();

assert_eq!(ipld, Ipld::String("Hello World!".to_string()));

pub fn ipld(&self) -> Result<Ipld, Error>where
    Ipld: Decode<<S as StoreParams>::Codecs>,

Returns the decoded ipld.

pub fn references<E>(&self, set: &mut E) -> Result<(), Error>where
    E: Extend<Cid<64>>,
    Ipld: References<<S as StoreParams>::Codecs>,

Returns the references.

Methods from Deref<Target = Cid<64>>

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<(), Error>where
    W: Write,

Writes the bytes to a byte stream.

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

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::{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<S> AsRef<[u8]> for Block<S>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<S> AsRef<Cid<64>> for Block<S>

fn as_ref(&self) -> &Cid<64>

Converts this type into a shared reference of the (usually inferred) input type.

impl<S> Borrow<Cid<64>> for Block<S>

fn borrow(&self) -> &Cid<64>

Immutably borrows from an owned value.

impl<S> Clone for Block<S>where
    S: Clone,

fn clone(&self) -> Block<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Debug for Block<S>

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

Formats the value using the given formatter.

impl<S> Deref for Block<S>

type Target = Cid<64>

The resulting type after dereferencing.

fn deref(&self) -> &<Block<S> as Deref>::Target

Dereferences the value.

impl<S> Hash for Block<S>

fn hash<SH>(&self, hasher: &mut SH)where
    SH: Hasher,

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<S> PartialEq<Block<S>> for Block<S>

fn eq(&self, other: &Block<S>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<S> Eq for Block<S>