Struct ssbh_lib::SsbhString

pub struct SsbhString(_);

A 4-byte aligned CString with position determined by a relative offset.

Implementations

impl SsbhString

pub fn from_bytes(bytes: Vec<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 offset is null or the conversion failed.

pub fn to_string_lossy(&self) -> String

Converts the underlying buffer to a String. Empty or null values are converted to empty strings.

Trait Implementations

impl BinRead for SsbhString

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>(
    __binread_generated_var_reader: &mut R,
    __binread_generated_var_options: &ReadOptions,
    __binread_generated_var_arguments: Self::Args
) -> BinResult<Self>

Read the type from the reader

fn read<R>(reader: &mut R) -> Result<Self, Error> where
    R: Read + Seek, 

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

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

Read the type from the reader using the specified arguments

fn after_parse<R>(
    &mut self,
    &mut R,
    &ReadOptions,
    Self::Args
) -> Result<(), Error> where
    R: Read + Seek, 

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 Debug for SsbhString

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SsbhString

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

Deserialize this value from the given Serde deserializer.

impl From<&'_ str> for SsbhString

fn from(text: &str) -> Self

Performs the conversion.

impl From<String> for SsbhString

fn from(text: String) -> Self

Performs the conversion.

impl FromStr for SsbhString

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

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

Serialize this value into the given Serde serializer.

impl SsbhWrite for SsbhString

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

Writes the byte representation of self to writer and update data_ptr as needed to ensure the next relative offset is correctly calculated.

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. For most types, this is simply the value of std::mem::size_of.

fn alignment_in_bytes(&self) -> u64

The alignment of the relative_offset for types stored in a RelPtr64.