Struct rspolib::MOFile

pub struct MOFile {
    pub magic_number: Option<u32>,
    pub version: Option<u32>,
    pub metadata: HashMap<String, String>,
    pub entries: Vec<MOEntry>,
    pub options: FileOptions,
}

MO file

Fields

magic_number: Option<u32>

Magic number, either MAGIC or MAGIC_SWAPPED

version: Option<u32>

Version number, either 0 or 1

metadata: HashMap<String, String>

Metadata as a hash map

entries: Vec<MOEntry>

Message entries

options: FileOptions

File options. See FileOptions.

Implementations

impl MOFile

pub fn new(options: FileOptions) -> Self

pub fn metadata_as_entry(&self) -> MOEntry

Returns the metadata as a MOEntry

pub fn find( &self, value: &str, by: &str, msgctxt: Option<&str> ) -> Vec<&MOEntry>

Find entries by a given field and value

The field defined in the by argument can be one of:

• msgid
• msgstr
• msgctxt
• msgid_plural

Passing the optional msgctxt argument the entry will also must match with the given context.

pub fn find_by_msgid(&self, msgid: &str) -> Option<&MOEntry>

Find an entry by msgid

pub fn find_by_msgid_msgctxt( &self, msgid: &str, msgctxt: &str ) -> Option<&MOEntry>

Find an entry by msgid and msgctxt

pub fn remove(&mut self, entry: &MOEntry)

Remove an entry from the file

pub fn remove_by_msgid(&mut self, msgid: &str)

Remove the first entry that has the same msgid

pub fn remove_by_msgid_msgctxt(&mut self, msgid: &str, msgctxt: &str)

Remove the first entry that has the same msgid and msgctxt

pub fn as_bytes_with( &self, magic_number: u32, revision_number: u32 ) -> Cow<'_, [u8]>

Returns the entry as a bytes vector

Specify the magic number and the revision number of the generated MO version of the file.

This method does not check the validity of the values magic_number and revision_version to allow the experimental developing of other revision of MO files, so be careful about the passed values if you use it.

Valid values for the magic number are MAGIC and MAGIC_SWAPPED. Valid values for the revision number are 0 and 1.

Example

use rspolib::mofile;

let file = mofile("tests-data/all.mo").unwrap();
let bytes = file.as_bytes_with(rspolib::MAGIC_SWAPPED, 1);
assert_eq!(bytes.len(), 1327);

Trait Implementations

impl AsBytes for MOFile

fn as_bytes(&self) -> Cow<'_, [u8]>

Return the MOFile as a vector of bytes in little endian

fn as_bytes_le(&self) -> Cow<'_, [u8]>

Return the MOFile as a vector of bytes in little endian

fn as_bytes_be(&self) -> Cow<'_, [u8]>

Return the MOFile as a vector of bytes in big endian

impl Clone for MOFile

fn clone(&self) -> MOFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MOFile

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

Formats the value using the given formatter.

impl Display for MOFile

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

Formats the value using the given formatter.

impl From<&POFile> for MOFile

fn from(file: &POFile) -> MOFile

Converts to this type from the input type.

impl From<&Path> for MOFile

fn from(path: &Path) -> Self

Converts to this type from the input type.

impl From<Vec<&MOEntry>> for MOFile

fn from(entries: Vec<&MOEntry>) -> Self

Converts to this type from the input type.

impl PartialEq for MOFile

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

fn save(&self, path: &str)

Save the MOFile to a file at the given path

impl SaveAsMOFile for MOFile

fn save_as_mofile(&self, path: &str)

Save the MOFile to a file at the given path

impl SaveAsPOFile for MOFile

fn save_as_pofile(&self, path: &str)

where Self: Display,

Save the file as a PO file to the given path

impl StructuralPartialEq for MOFile