Struct DeviceSQLString

pub struct DeviceSQLString(/* private fields */);

Encapsulates the intrinsics of the format used by DeviceSQL strings

Once A DeviceSQLString has been constructed, there is no way to change it.

use rekordcrate::pdb::string::DeviceSQLString;
use binrw::{BinWrite, BinRead};
let string = DeviceSQLString::new("foo".to_owned()).unwrap();
let binary = vec![0x9, 0x66, 0x6F, 0x6F];

let mut writer = binrw::io::Cursor::new(vec![]);
string.write(&mut writer)?;
assert_eq!(&binary, writer.get_ref());

let mut reader = binrw::io::Cursor::new(binary);
let parsed = DeviceSQLString::read(&mut reader)?;
assert_eq!(parsed, string);

Implementations

impl DeviceSQLString

pub fn new(string: String) -> Result<Self, StringError>

Initializes a DeviceSQLString from a plain Rust std::string::String

pub fn new_isrc(string: String) -> Result<Self, StringError>

Creates a DeviceSQLString containing an ISRC instead of an expected string

The DeviceSQL Database as used by rekordbox has a strange oddity where it serializes strings containing a tracks ISRC (International Standard Recording Code) in an unexpected format, if this is desired, use this constructor function instead of DeviceSQLString::new.

pub fn into_string(self) -> Result<String, StringError>

Extract the Rust string from the DeviceSQLString.

Consumes itself in the process.

pub const fn empty() -> Self

Create an empty DeviceSQLString.

Should be used to construct known empty strings.

Trait Implementations

impl BinRead for DeviceSQLString

type Args<'__binrw_generated_args_lifetime> = ()

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

fn read_options<R: Read + Seek>( __binrw_generated_var_reader: &mut R, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_>, ) -> BinResult<Self>

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

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

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

Read Self from the reader using default 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_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek, Self: ReadEndian,

Read Self from the reader using the given arguments.

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 BinWrite for DeviceSQLString

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of write_args() and write_options().

fn write_options<W: Write + Seek>( &self, __binrw_generated_var_writer: &mut W, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_>, ) -> BinResult<()>

Write Self to the writer using the given [Endian] and arguments.

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

where W: Write + Seek, Self: WriteEndian, Self::Args<'a>: for<'a> Required,

Write Self to the writer using default arguments.

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

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming big-endian byte order.

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

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming little-endian byte order.

fn write_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek, Self: WriteEndian,

Write Self to the writer using the given arguments.

fn write_be_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming big-endian byte order, using the given arguments.

fn write_le_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming little-endian byte order, using the given arguments.

impl Clone for DeviceSQLString

fn clone(&self) -> DeviceSQLString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceSQLString

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

Formats the value using the given formatter.

impl Default for DeviceSQLString

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for DeviceSQLString

fn eq(&self, other: &DeviceSQLString) -> 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 ReadEndian for DeviceSQLString

const ENDIAN: EndianKind = _

The endianness of the type.

impl WriteEndian for DeviceSQLString

const ENDIAN: EndianKind = _

The endianness of the type.

impl Eq for DeviceSQLString

impl StructuralPartialEq for DeviceSQLString