Struct Codec

pub struct Codec {
    pub resources: Box<Vec<Resource>>,
}

Represents a collection of localized resources and provides methods to read, write, cache, and load these resources.

Fields

resources: Box<Vec<Resource>>

The collection of resources managed by this codec.

Implementations

impl Codec

pub fn new() -> Self

Creates a new, empty Codec.

Returns

A new Codec instance with no resources.

pub fn iter(&self) -> Iter<'_, Resource>

Returns an iterator over all resources.

pub fn iter_mut(&mut self) -> IterMut<'_, Resource>

Returns a mutable iterator over all resources.

pub fn get_by_language(&self, lang: &str) -> Option<&Resource>

Finds a resource by its language code, if present.

pub fn get_mut_by_language(&mut self, lang: &str) -> Option<&mut Resource>

Finds a mutable resource by its language code, if present.

pub fn add_resource(&mut self, resource: Resource)

Adds a new resource to the collection.

pub fn read_file_by_type<P: AsRef<Path>>( &mut self, path: P, format_type: FormatType, ) -> Result<(), Error>

Reads a resource file given its path and explicit format type.

Parameters

• path: Path to the resource file.
• format_type: The format type of the resource file.

Returns

Ok(()) if the file was successfully read and resources loaded, or an Error otherwise.

pub fn read_file_by_extension<P: AsRef<Path>>( &mut self, path: P, lang: Option<String>, ) -> Result<(), Error>

Reads a resource file by inferring its format from the file extension. Optionally infers language from the path if not provided.

Parameters

• path: Path to the resource file.
• lang: Optional language code to use.

Returns

Ok(()) if the file was successfully read, or an Error if the format is unsupported or reading fails.

pub fn write_to_file(&self) -> Result<(), Error>

Writes all managed resources back to their respective files, grouped by domain.

Returns

Ok(()) if all writes succeed, or an Error otherwise.

pub fn cache_to_file<P: AsRef<Path>>(&self, path: P) -> Result<(), Error>

Caches the current resources to a JSON file.

Parameters

• path: Destination file path for the cache.

Returns

Ok(()) if caching succeeds, or an Error if file I/O or serialization fails.

pub fn load_from_file<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Loads resources from a JSON cache file.

Parameters

• path: Path to the JSON file containing cached resources.

Returns

Ok(Codec) with loaded resources, or an Error if loading or deserialization fails.