Struct ipfs_embed::Block

source · [−]

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

Expand description

Block

Implementations

source

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

source

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

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

source

pub fn new_unchecked(
cid: Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>,
data: Vec<u8, Global>
) -> Block<S>

Creates a new block without verifying the cid.

source

pub fn cid(
&self
) -> &Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>

Returns the cid.

source

pub fn data(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Returns the payload.

source

pub fn into_inner(
self
) -> (Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>, Vec<u8, Global>)

Returns the inner cid and data.

source

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.`

source

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()));

source

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

Returns the decoded ipld.

source

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

Returns the references.

Methods from Deref<Target = Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>>

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>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

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

source

impl<S> AsRef<[u8 ]> for Block<S>

source

fn as_ref(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

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

source

impl<S> AsRef<Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for Block<S>

source

fn as_ref(
&self
) -> &Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>

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

source

impl<S> Borrow<Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for Block<S>

source

fn borrow(
&self
) -> &Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>

Immutably borrows from an owned value. Read more

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<S> Debug for Block<S>

source

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

Formats the value using the given formatter. Read more

source

impl<S> Deref for Block<S>

type Target = Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>

The resulting type after dereferencing.

source

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

Dereferences the value.

source

impl<S> Hash for Block<S>

source

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

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,

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

source

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

source

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

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

1.0.0 · source

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

This method tests for !=.

source

impl<S> Eq for Block<S>

Auto Trait Implementations

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

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

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

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

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

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> CallHasher for T where
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

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

const: unstable · 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.

impl<T> ProtocolName for T where
T: AsRef<[u8 ]>,

fn protocol_name(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

The protocol name as bytes. Transmitted on the network. Read more

impl<T> References<RawCodec> for T

fn references<R, E>(_c: RawCodec, _r: &mut R, _set: &mut E) -> Result<(), Error> where
R: Read,
E: Extend<Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>>,

Scrape the references from an impl Read. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToHex for T where
T: AsRef<[u8 ]>,

source

fn encode_hex(&self) -> U where
U: FromIterator<char>,

Encode the hex strict representing self into the result. Lower case letters are used (e.g. f9b4ca) Read more

source

fn encode_hex_upper(&self) -> U where
U: FromIterator<char>,

Encode the hex strict representing self into the result. Upper case letters are used (e.g. F9B4CA) Read more

source

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

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)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct ipfs_embed::Block

Implementations

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

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

pub fn new_unchecked( cid: Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>, data: Vec<u8, Global>) -> Block<S>

pub fn cid( &self) -> &Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>

pub fn data(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

pub fn into_inner( self) -> (Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>, Vec<u8, Global>)

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,

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

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

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

Methods from Deref<Target = Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>>

pub fn version(&self) -> Version

pub fn codec(&self) -> u64

pub fn hash(&self) -> &Multihash<S>

pub fn write_bytes<W>(&self, w: W) -> Result<(), Error> where W: Write,

pub fn to_bytes(&self) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn to_string_of_base(&self, base: Base) -> Result<String, Error>

Trait Implementations

impl<S> AsRef<[u8]> for Block<S>

fn as_ref(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

impl<S> AsRef<Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for Block<S>

fn as_ref( &self) -> &Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>

impl<S> Borrow<Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for Block<S>

fn borrow( &self) -> &Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>

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

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

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

impl<S> Debug for Block<S>

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

impl<S> Deref for Block<S>

type Target = Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>

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

impl<S> Hash for Block<S>

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

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

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

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

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

impl<S> Eq for Block<S>

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> CallHasher for T where T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where H: Hash + ?Sized, B: BuildHasher,

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> ProtocolName for T where T: AsRef<[u8]>,

fn protocol_name(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

impl<T> References<RawCodec> for T

fn references<R, E>(_c: RawCodec, _r: &mut R, _set: &mut E) -> Result<(), Error> where R: Read, E: Extend<Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>>,

impl<T> Same<T> for T

type Output = T

impl<T> ToHex for T where T: AsRef<[u8]>,

fn encode_hex<U>(&self) -> U where U: FromIterator<char>,

fn encode_hex_upper<U>(&self) -> U where U: FromIterator<char>,

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

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

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

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

pub fn new_unchecked(
cid: Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>,
data: Vec<u8, Global>
) -> Block<S>

pub fn cid(
&self
) -> &Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>

pub fn data(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

pub fn into_inner(
self
) -> (Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>, Vec<u8, Global>)

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,

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

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

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

pub fn write_bytes<W>(&self, w: W) -> Result<(), Error> where
W: Write,

pub fn to_bytes(&self) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

impl<S> AsRef<[u8 ]> for Block<S>

fn as_ref(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

fn as_ref(
&self
) -> &Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>

fn borrow(
&self
) -> &Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>

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

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

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

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

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

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

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

impl<T> CallHasher for T where
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

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

impl<T> ProtocolName for T where
T: AsRef<[u8 ]>,

fn protocol_name(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

fn references<R, E>(_c: RawCodec, _r: &mut R, _set: &mut E) -> Result<(), Error> where
R: Read,
E: Extend<Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>>,

impl<T> ToHex for T where
T: AsRef<[u8 ]>,

fn encode_hex<U>(&self) -> U where
U: FromIterator<char>,

fn encode_hex_upper<U>(&self) -> U where
U: FromIterator<char>,

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

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,