Struct binread::NullString

pub struct NullString(pub Vec<u8>);

A null terminated UTF-8 string designed to make reading any null-terminated data easier.

Note: Result does not include the null, but the null is consumed from the Reader.

use binread::{BinRead, BinReaderExt, NullString, io::Cursor};

let mut null_separated_strings = Cursor::new(b"null terminated strings? in my system's language?\0no thanks\0");

assert_eq!(
    null_separated_strings.read_be::<NullString>().unwrap().into_string(),
    "null terminated strings? in my system's language?"
);

assert_eq!(
    null_separated_strings.read_be::<NullString>().unwrap().into_string(),
    "no thanks"
);

Tuple Fields

0: Vec<u8>

Implementations

impl NullString

pub fn into_string(self) -> String

pub fn into_string_lossless(self) -> Result<String, FromUtf8Error>

Methods from Deref<Target = Vec<u8>>

pub fn capacity(&self) -> usize

Returns the number of elements the vector can hold without reallocating.

Examples

let vec: Vec<i32> = Vec::with_capacity(10);
assert_eq!(vec.capacity(), 10);

pub fn as_slice(&self) -> &[T]

Extracts a slice containing the entire vector.

Equivalent to &s[..].

Examples

use std::io::{self, Write};
let buffer = vec![1, 2, 3, 5, 8];
io::sink().write(buffer.as_slice()).unwrap();

pub fn as_ptr(&self) -> *const T

Returns a raw pointer to the vector’s buffer.

The caller must ensure that the vector outlives the pointer this function returns, or else it will end up pointing to garbage. Modifying the vector may cause its buffer to be reallocated, which would also make any pointers to it invalid.

The caller must also ensure that the memory the pointer (non-transitively) points to is never written to (except inside an UnsafeCell) using this pointer or any pointer derived from it. If you need to mutate the contents of the slice, use as_mut_ptr.

Examples

let x = vec![1, 2, 4];
let x_ptr = x.as_ptr();

unsafe {
    for i in 0..x.len() {
        assert_eq!(*x_ptr.add(i), 1 << i);
    }
}

pub fn allocator(&self) -> &A

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

Returns a reference to the underlying allocator.

pub fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its ‘length’.

Examples

let a = vec![1, 2, 3];
assert_eq!(a.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

Examples

let mut v = Vec::new();
assert!(v.is_empty());

v.push(1);
assert!(!v.is_empty());

Trait Implementations

impl BinRead for NullString

type Args = ()

The type of arguments needed to be supplied in order to read this type, usually a tuple.

fn read_options<R: Read + Seek>(
    reader: &mut R,
    options: &ReadOptions,
    args: Self::Args
) -> BinResult<Self>

Read the type from the reader

fn read<R: Read + Seek>(reader: &mut R) -> BinResult<Self>

Read the type from the reader while assuming no arguments have been passed

fn read_args<R: Read + Seek>(
    reader: &mut R,
    args: Self::Args
) -> BinResult<Self>

Read the type from the reader using the specified arguments

fn after_parse<R: Read + Seek>(
    &mut self,
    _: &mut R,
    _: &ReadOptions,
    _: Self::Args
) -> BinResult<()>

fn args_default() -> Option<Self::Args>

The default arguments to be used when using the read shortcut method. Override this for any type that optionally requries arguments

impl Clone for NullString

fn clone(&self) -> NullString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NullString

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

Formats the value using the given formatter.

impl Default for NullString

fn default() -> NullString

Returns the “default value” for a type.

impl Deref for NullString

type Target = Vec<u8>

The resulting type after dereferencing.

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

Dereferences the value.

impl From<NullString> for Vec<u8>

fn from(s: NullString) -> Self

Performs the conversion.

impl From<Vec<NonZeroU8, Global>> for NullString

fn from(v: Vec<NonZeroU8>) -> Self

Performs the conversion.

impl PartialEq<NullString> for NullString

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

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

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

This method tests for !=.

impl ToString for NullString

fn to_string(&self) -> String

Converts the given value to a String.

impl StructuralPartialEq for NullString