Struct blob::Blob

pub struct Blob<C: Config = Standard> { /* fields omitted */ }

Blob structure containing binary data

Interally, the blob is stored as a plain Vec<u8>, and some methods are exposed from that. If you need full access to the underlying Vec, use borrow() or borrow_mut()

Methods

impl<C: Config> Blob<C>

Important traits for Blob<C>

impl<C: Config> Write for Blob<C>

pub fn new() -> Blob<C>

Create a new empty Blob

Important traits for Blob<C>

impl<C: Config> Write for Blob<C>

pub fn from_vec(vec: Vec<u8>) -> Blob<C>

Create a Blob from an underlying Vec

Important traits for Blob<C>

impl<C: Config> Write for Blob<C>

pub fn with_capacity(capacity: usize) -> Blob<C>

Create a new Blob with the given capacity

pub fn capacity(&self) -> usize

Returns the number of bytes the Blob can hold without reallocating.

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more bytes to be inserted in the given Blob

Important traits for Blob<C>

impl<C: Config> Write for Blob<C>

pub fn with_config<E: Config>(self) -> Blob<E>

Use a different encoding configuration for the Blob

pub fn encode_base64(&self) -> String

Encode the Blob to a base-64 string

pub fn encode_to<W: Write>(&self, writer: W) -> Result<()>

Encodes the Blob as base-64 to an io::Writer, avoiding intermediate allocations

pub fn decode_base64<T>(encoded: T) -> Result<Blob<C>, DecodeError> where     T: AsRef<[u8]>,

Decode base-64 encoded data into a Blob

pub fn append_base64<T>(&mut self, encoded: T) -> Result<(), DecodeError> where     T: AsRef<[u8]>,

Decodes some base-64 data and appends it to the Blob

pub fn into_vec(self) -> Vec<u8>

Consume self and return the inner Vec<u8>

Trait Implementations

impl<T, C: Config> From<T> for Blob<C> where     T: Into<Vec<u8>>,

Important traits for Blob<C>

impl<C: Config> Write for Blob<C>

fn from(value: T) -> Blob<C>

Performs the conversion.

impl<C: Config> IntoIterator for Blob<C>

type Item = u8

The type of the elements being iterated over.

type IntoIter = IntoIter<u8>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, C: Config> IntoIterator for &'a Blob<C>

type Item = &'a u8

The type of the elements being iterated over.

type IntoIter = Iter<'a, u8>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, C: Config> IntoIterator for &'a mut Blob<C>

type Item = &'a mut u8

The type of the elements being iterated over.

type IntoIter = IterMut<'a, u8>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<C: Config> Eq for Blob<C>

impl<C: Config> Extend<u8> for Blob<C>

fn extend<T>(&mut self, iter: T) where     T: IntoIterator<Item = u8>,

Extends a collection with the contents of an iterator.

impl<'a, C: Config> Extend<&'a u8> for Blob<C>

fn extend<T>(&mut self, iter: T) where     T: IntoIterator<Item = &'a u8>,

Extends a collection with the contents of an iterator.

impl<C: Config> AsMut<[u8]> for Blob<C>

fn as_mut(&mut self) -> &mut [u8]

Performs the conversion.

impl<C: Config> AsMut<Vec<u8>> for Blob<C>

fn as_mut(&mut self) -> &mut Vec<u8>

Performs the conversion.

impl<C: Config> Default for Blob<C>

fn default() -> Self

Returns the "default value" for a type.

impl<C: Config> PartialEq<Blob<C>> for Blob<C>

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T, C: Config> PartialEq<T> for Blob<C> where     Vec<u8>: PartialEq<T>,

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<C: Config> AsRef<[u8]> for Blob<C>

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

Performs the conversion.

impl<C: Config> AsRef<Vec<u8>> for Blob<C>

fn as_ref(&self) -> &Vec<u8>

Performs the conversion.

impl<C: Config> Clone for Blob<C>

Important traits for Blob<C>

impl<C: Config> Write for Blob<C>

fn clone(&self) -> Blob<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Config> Debug for Blob<C>

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

Formats the value using the given formatter.

impl<C: Config> Display for Blob<C>

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

Formats the value using the given formatter.

impl<C: Config> DerefMut for Blob<C>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<C: Config> Deref for Blob<C>

type Target = [u8]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<C: Config> Hash for Blob<C>

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,

Feeds a slice of this type into the given [Hasher].

impl<C: Config> FromIterator<u8> for Blob<C>

Important traits for Blob<C>

impl<C: Config> Write for Blob<C>

fn from_iter<I>(iter: I) -> Blob<C> where     I: IntoIterator<Item = u8>,

Creates a value from an iterator.

impl<C: Config> FromStr for Blob<C>

type Err = DecodeError

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<C: Config> Borrow<Vec<u8>> for Blob<C>

fn borrow(&self) -> &Vec<u8>

Immutably borrows from an owned value.

impl<C: Config> Write for Blob<C>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn write_all(&mut self, buf: &[u8]) -> Result<()>

Attempts to write an entire buffer into this writer.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.

impl<C: Config> BorrowMut<Vec<u8>> for Blob<C>

fn borrow_mut(&mut self) -> &mut Vec<u8>

Mutably borrows from an owned value.

impl<C: Config> Serialize for Blob<C>

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

Serialize this value into the given Serde serializer.

impl<'de, C: Config> Deserialize<'de> for Blob<C>

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

Deserialize this value from the given Serde deserializer.