Skip to main content

DbStr

Struct DbStr 

Source
pub struct DbStr<'a>(/* private fields */);
Expand description

A borrowed or owned run of bytes from a file.

Not a string. LCF records no encoding, so this crate does not pretend to know one (see the crate docs). The bytes are whatever the authoring machine’s codepage produced: commonly Shift-JIS or CP1252, but the format does not say which.

Borrows from the input until into_owned, so loading copies no text.

Implementations§

Source§

impl<'a> DbStr<'a>

Source

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

Borrow a run of bytes.

Source

pub const fn from_vec(bytes: Vec<u8>) -> Self

Take ownership of a run of bytes.

Source

pub fn as_bytes(&self) -> &[u8] ⓘ

The bytes, exactly as they appeared in the file.

Source

pub fn len(&self) -> usize

Length in bytes.

Source

pub fn is_empty(&self) -> bool

Whether the field is empty. Empty is the default for every string field, so the writer elides it.

Source

pub fn into_owned(self) -> DbStr<'static>

Detach from the input buffer.

Source

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

Interpret as UTF-8, if it happens to be valid.

Returns None otherwise, including for most non-English games. Meant for incidentally-ASCII values like a filename or identifier; it is not an encoding layer.

Trait Implementations§

Source§

impl<'a> Clone for DbStr<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for DbStr<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Default for DbStr<'a>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'a> Eq for DbStr<'a>

Source§

impl<'a> From<&'a [u8]> for DbStr<'a>

Source§

fn from(bytes: &'a [u8]) -> Self

Converts to this type from the input type.
Source§

impl<'a> Hash for DbStr<'a>

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl IntoOwned for DbStr<'_>

Source§

type Owned = DbStr<'static>

The same shape, owning its data.
Source§

fn into_owned(self) -> DbStr<'static>

Copy anything still borrowed, so the result outlives the input buffer.
Source§

impl<'a> LcfField<'a> for DbStr<'a>

Source§

fn field_default(_engine: Engine) -> Self

The value this field holds when its chunk is absent and the schema gives no explicit default. Read more
Source§

fn read( data: &'a [u8], _ctx: &mut Ctx<'_>, _owner: &'static str, _id: u32, ) -> Self

Decode from a chunk payload sliced to exactly this field’s bytes. Read more
Source§

fn lcf_size(&self, _engine: Engine) -> u32

Encoded length in bytes, which the two-pass writer emits as the chunk’s length prefix.
Source§

fn element_count(&self) -> u32

Number of elements, for array-like fields. Read more
Source§

fn write<S: Sink>(&self, sink: &mut S, _engine: Engine) -> Result<(), S::Error>

Append the encoded payload. Read more
Source§

fn lcf_differs(&self, other: &Self) -> bool
where Self: PartialEq,

Whether self differs from other in its written form; the writer elides a field equal to its default. Plain !=, except floats compare by bits: -0.0 == 0.0, so != would drop a stored -0.0 and break the round trip.
Source§

impl<'a> Ord for DbStr<'a>

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl<'a> PartialEq for DbStr<'a>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'a> PartialOrd for DbStr<'a>

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<'a> StructuralPartialEq for DbStr<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for DbStr<'a>

§

impl<'a> RefUnwindSafe for DbStr<'a>

§

impl<'a> Send for DbStr<'a>

§

impl<'a> Sync for DbStr<'a>

§

impl<'a> Unpin for DbStr<'a>

§

impl<'a> UnsafeUnpin for DbStr<'a>

§

impl<'a> UnwindSafe for DbStr<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.