Skip to main content

Report

Struct Report 

Source
pub struct Report {
    pub schema_version: u32,
    pub summary: Summary,
    pub missing_keys: Vec<MissingKey>,
    pub inconsistent_keys: Vec<InconsistentKey>,
    pub duplicate_keys: Vec<DuplicateKey>,
    pub unused_keys: Vec<UnusedKey>,
    pub parse_errors: Vec<ParseError>,
    pub unused_severity: Severity,
}
Expand description

The result of a full run. It contains findings and performs no output.

Fields§

§schema_version: u32

Version of the JSON shape, bumped on any breaking change.

§summary: Summary

Counts and context.

§missing_keys: Vec<MissingKey>

Keys used but missing from at least one locale.

§inconsistent_keys: Vec<InconsistentKey>

Keys that some locales define and others do not.

§duplicate_keys: Vec<DuplicateKey>

Keys defined more than once in one locale.

§unused_keys: Vec<UnusedKey>

Keys defined but never used.

§parse_errors: Vec<ParseError>

Fluent syntax errors.

§unused_severity: Severity

Severity configured for unused_keys, which decides the exit code.

Implementations§

Source§

impl Report

Source

pub fn has_errors(&self) -> bool

Whether the run found anything that should fail the build.

Source

pub fn has_warnings(&self) -> bool

Whether the run found anything worth mentioning but not failing on.

Source

pub fn is_vacuous(&self) -> bool

Whether no locale was checked. When this is true, the coverage, and consistency checks are inapplicable.

This only happens with --require-locales=false. The run must never be reported as clean in this case.

Source

pub fn exit_code(&self) -> u8

Process exit code: 0 when clean, 1 when there are errors.

Source

pub fn finding_count(&self) -> usize

Total number of findings, at any severity.

Trait Implementations§

Source§

impl Clone for Report

Source§

fn clone(&self) -> Report

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 Debug for Report

Source§

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

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

impl Serialize for Report

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

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

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.