Struct TarFormatString

#[repr(C)]
pub struct TarFormatString<const N: usize> { /* private fields */ }

Base type for strings embedded in a Tar header. The length depends on the context. The returned string is likely to be UTF-8/ASCII, which is verified by getters, such as TarFormatString::as_str.

An optionally null terminated string. The contents are either:

1. A fully populated string with no null termination or
2. A partially populated string where the unused bytes are zero.

Implementations

impl<const N: usize> TarFormatString<N>

A Tar format string is a fixed length byte array containing UTF-8 bytes. This string will be null terminated if it doesn’t fill the entire array.

pub const fn new(bytes: [u8; N]) -> Self

Constructor.

pub const fn is_empty(&self) -> bool

True if the is string empty (ignoring NULL bytes).

pub fn size(&self) -> usize

Returns the length of the payload in bytes. This is either the full capacity N or the data until the first NULL byte.

pub fn as_str(&self) -> Result<&str, Utf8Error>

Returns a str ref without terminating or intermediate NULL bytes. The string is truncated at the first NULL byte, in case not the full length was used.

pub fn as_str_until_first_space(&self) -> Result<&str, Utf8Error>

Wrapper around Self::as_str that stops as soon as the first space is found. This is necessary to properly parse certain Tar-style encoded numbers. Some ustar implementations pad spaces which prevents the proper parsing as number.

pub fn append<const S: usize>(&mut self, other: &TarFormatString<S>)

Append to end of string. Panics if there is not enough capacity.

Trait Implementations

impl<const N: usize> Clone for TarFormatString<N>

fn clone(&self) -> TarFormatString<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for TarFormatString<N>

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

Formats the value using the given formatter.

impl<const N: usize> PartialEq for TarFormatString<N>

fn eq(&self, other: &TarFormatString<N>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<const N: usize> Copy for TarFormatString<N>

impl<const N: usize> Eq for TarFormatString<N>

impl<const N: usize> StructuralPartialEq for TarFormatString<N>