Struct ssbh_lib::CString

pub struct CString<const N: usize>(/* private fields */);

A null terminated string with a specified alignment. The empty string is represented as N null bytes.

Implementations

impl<const N: usize> CString<N>

pub fn from_bytes(bytes: &[u8]) -> Self

Creates the string by reading from bytes until the first null byte.

pub fn to_str(&self) -> Option<&str>

Converts the underlying buffer to a str. The result will be None if the the conversion failed.

pub fn to_string_lossy(&self) -> String

Converts the underlying buffer to a String.

Trait Implementations

impl<const N: usize> BinRead for CString<N>

type Args<'a> = ()

The type used for the args parameter of read_args() and read_options().

fn read_options<R: Read + Seek>( reader: &mut R, _endian: Endian, _args: Self::Args<'_> ) -> BinResult<Self>

Read Self from the reader using the given Endian and arguments.

fn read_be<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming big-endian byte order.

fn read_le<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming little-endian byte order.

fn read_ne<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read T from the reader assuming native-endian byte order.

fn read_be_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming big-endian byte order, using the given arguments.

fn read_le_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming little-endian byte order, using the given arguments.

fn read_ne_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read T from the reader, assuming native-endian byte order, using the given arguments.

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

fn clone(&self) -> CString<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 CString<N>

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

Formats the value using the given formatter.

impl<const N: usize> From<&String> for CString<N>

fn from(text: &String) -> Self

Converts to this type from the input type.

impl<const N: usize> From<&str> for CString<N>

fn from(text: &str) -> Self

Converts to this type from the input type.

impl<const N: usize> From<String> for CString<N>

fn from(text: String) -> Self

Converts to this type from the input type.

impl<const N: usize> FromStr for CString<N>

type Err = Infallible

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<const N: usize> PartialEq for CString<N>

fn eq(&self, other: &CString<N>) -> 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<const N: usize> SsbhWrite for CString<N>

fn ssbh_write<W: Write + Seek>( &self, writer: &mut W, _data_ptr: &mut u64 ) -> Result<()>

Writes the byte representation of self to writer. data_ptr is assumed to be the absolute offset where the next data stored behind an offset will be written. Struct that contains no offsets as fields can skip updating data_ptr.

fn size_in_bytes(&self) -> u64

The offset in bytes between successive elements in an array of this type. This should include any alignment or padding.

fn alignment_in_bytes() -> u64

The alignment for pointers of this type, which is useful for offset calculations.

fn write<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek,

Writes the byte representation of self to writer. This is a convenience method for ssbh_write that handles initializing the data pointer.

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

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