Struct nbt::Blob

pub struct Blob { /* private fields */ }

A generic, complete object in Named Binary Tag format.

This is essentially a map of names to Values, with an optional top-level name of its own. It can be created in a similar way to a HashMap, or read from an io::Read source, and its binary representation can be written to an io::Write destination.

These read and write methods support both uncompressed and compressed (through Gzip or zlib compression) methods.

use nbt::{Blob, Value, Endianness};

// Create a `Blob` from key/value pairs.
let mut nbt = Blob::new();
nbt.insert("name", "Herobrine").unwrap();
nbt.insert("health", 100i8).unwrap();
nbt.insert("food", 20.0f32).unwrap();

// Write a compressed binary representation to a byte array.
let mut dst = Vec::new();
nbt.to_zlib_writer(&mut dst, Endianness::BigEndian).unwrap();

Implementations

impl Blob

pub fn new() -> Blob

Create a new NBT file format representation with an empty name.

pub fn named<S>(name: S) -> Blobwhere
S: Into<String>,

Create a new NBT file format representation with the given name.

pub fn from_reader<R>(src: &mut R, endian: Endianness) -> Result<Blob>where
R: Read,

Extracts an Blob object from an io::Read source.

pub fn from_gzip_reader<R>(src: &mut R, endian: Endianness) -> Result<Blob>where
R: Read,

Extracts an Blob object from an io::Read source that is compressed using the Gzip format.

pub fn from_zlib_reader<R>(src: &mut R, endian: Endianness) -> Result<Blob>where
R: Read,

Extracts an Blob object from an io::Read source that is compressed using the zlib format.

pub fn to_writer<W>(&self, dst: &mut W, endian: Endianness) -> Result<()>where
W: Write,

Writes the binary representation of this Blob to an io::Write destination.

pub fn to_gzip_writer<W>(&self, dst: &mut W, endian: Endianness) -> Result<()>where
W: Write,

Writes the binary representation of this Blob, compressed using the Gzip format, to an io::Write destination.

pub fn to_zlib_writer<W>(&self, dst: &mut W, endian: Endianness) -> Result<()>where
W: Write,

Writes the binary representation of this Blob, compressed using the Zlib format, to an io::Write dst.

pub fn insert<S, V>(&mut self, name: S, value: V) -> Result<()>where
S: Into<String>,
V: Into<Value>,

Insert an Value with a given name into this Blob object. This method is just a thin wrapper around the underlying HashMap method of the same name.

This method will also return an error if a Value::List with heterogeneous elements is passed in, because this is illegal in the NBT file format.

pub fn get<S>(&self, name: S) -> Option<&Value>where
S: Into<&'static str>,

Tries to get a named Value in the blob.

Trait Implementations

impl Clone for Blob

fn clone(&self) -> Blob

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Blob

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Blob

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

Deserialize this value from the given Serde deserializer.

impl Display for Blob

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

Formats the value using the given formatter.

impl<'a> Index<&'a str> for Blob

type Output = Value

The returned type after indexing.

fn index<'b>(&'b self, s: &'a str) -> &'b Value

Performs the indexing (container[index]) operation.

impl PartialEq<Blob> for Blob

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

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

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 Serialize for Blob

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Blob