Resource

Struct Resource 

Source
pub struct Resource {
    pub metadata: Metadata,
    pub entries: Vec<Entry>,
}
Expand description

A complete localization resource (corresponds to a .strings, .xml, .xcstrings, etc. file). Contains metadata and all entries for a single language and domain.

Fields§

§metadata: Metadata

Optional header-level metadata (language code, domain/project, etc.).

§entries: Vec<Entry>

Ordered list of all entries in this resource.

Implementations§

Source§

impl Resource

Source

pub fn add_entry(&mut self, entry: Entry)

Add an entry to the resource.

use langcodec::types::{Resource, Entry, Translation, EntryStatus, Metadata};
use std::collections::HashMap;

let mut resource = Resource {
    metadata: Metadata {
        language: "en".to_string(),
        domain: "test".to_string(),
        custom: HashMap::new(),
    },
    entries: Vec::new(),
};
resource.add_entry(Entry {
    id: "hello".to_string(),
    value: Translation::Singular("Hello".to_string()),
    status: EntryStatus::Translated,
    comment: None,
    custom: HashMap::new(),
});
§Returns

The added entry.

Source

pub fn find_entry(&self, id: &str) -> Option<&Entry>

Find an entry by its id.

use langcodec::types::{Resource, Entry, Translation, EntryStatus, Metadata};
use std::collections::HashMap;

let mut resource = Resource {
    metadata: Metadata {
        language: "en".to_string(),
        domain: "test".to_string(),
        custom: HashMap::new(),
    },
    entries: Vec::new(),
};
resource.add_entry(Entry {
    id: "hello".to_string(),
    value: Translation::Singular("Hello".to_string()),
    status: EntryStatus::Translated,
    comment: None,
    custom: HashMap::new(),
});
let entry = resource.find_entry("hello").unwrap();
assert_eq!(entry.value, Translation::Singular("Hello".to_string()));
assert_eq!(entry.status, EntryStatus::Translated);
assert_eq!(entry.comment, None);
Source

pub fn find_entry_mut(&mut self, id: &str) -> Option<&mut Entry>

Find a mutable entry by its id.

use langcodec::types::{Resource, Entry, Translation, EntryStatus, Metadata};
use std::collections::HashMap;

let mut resource = Resource {
    metadata: Metadata {
        language: "en".to_string(),
        domain: "test".to_string(),
        custom: HashMap::new(),
    },
    entries: Vec::new(),
};
resource.add_entry(Entry {
    id: "hello".to_string(),
    value: Translation::Singular("Hello".to_string()),
    status: EntryStatus::Translated,
    comment: None,
    custom: HashMap::new(),
});
let entry = resource.find_entry_mut("hello").unwrap();
assert_eq!(entry.value, Translation::Singular("Hello".to_string()));
assert_eq!(entry.status, EntryStatus::Translated);
assert_eq!(entry.comment, None);
entry.value = Translation::Singular("Hello, World!".to_string());
entry.status = EntryStatus::NeedsReview;
entry.comment = Some("Hello, World!".to_string());
assert_eq!(entry.value, Translation::Singular("Hello, World!".to_string()));
assert_eq!(entry.status, EntryStatus::NeedsReview);
assert_eq!(entry.comment, Some("Hello, World!".to_string()));
Source

pub fn parse_language_identifier(&self) -> Option<LanguageIdentifier>

Source

pub fn has_language(&self, lang: &str) -> bool

Check if this resource has a specific language.

Trait Implementations§

Source§

impl Clone for Resource

Source§

fn clone(&self) -> Resource

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Resource

Source§

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

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

impl<'de> Deserialize<'de> for Resource

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<Format> for Resource

Source§

fn from(value: Format) -> Self

Converts to this type from the input type.
Source§

impl From<Format> for Resource

Source§

fn from(value: Format) -> Self

Converts to this type from the input type.
Source§

impl From<Resource> for Format

Source§

fn from(value: Resource) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Resource

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Resource

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<Resource> for Format

Source§

type Error = Error

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

fn try_from(value: Resource) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl Eq for Resource

Source§

impl StructuralPartialEq for Resource

Auto Trait Implementations§

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,