Skip to main content

ParseResult

Enum ParseResult 

Source
pub enum ParseResult {
    Parsed(ParsedName),
    Informal(Informal),
    Unparsable(ParseError),
}
Expand description

The 5.0.0 exceptionless result of parse, mirroring Java org.gbif.nameparser.api.ParseResult: a structurally Parsed name, an Informal semistructured name (a taxon anchor carrying a provisional designation, e.g. Rhizobium sp. RMCC TR1811), or an Unparsable classification (virus, hybrid formula, placeholder, BOLD BIN, …). The 5.5%-of-corpus informal band is split off from Parsed at the parse boundary — see the verbatim-corpus study.

Parsed is far larger than the other two variants (it wraps the ~1 KB ParsedName vs ~56 B for Informal/ParseError), so clippy::large_enum_variant fires — but Parsed is the dominant outcome (≈89% of the corpus) and the value is decomposed immediately at the call boundary, so boxing it would add a heap allocation to the common path for no real gain. This mirrors parse_name’s own Result<ParsedName, ParseError>, which carries the identical size profile unboxed.

Variants§

§

Parsed(ParsedName)

A structurally parsed name carrying the full ParsedName atoms.

§

Informal(Informal)

An informal / semistructured name: a supraspecific anchor + a provisional, non-code designation, with no species epithet. See Informal.

§

Unparsable(ParseError)

A string that is not a parsable scientific name (virus, hybrid formula, placeholder, …).

Implementations§

Source§

impl ParseResult

Source

pub fn type_(&self) -> NameType

The name type, available on every variant (Java ParseResult.type()).

Source

pub fn code(&self) -> Option<NomCode>

The nomenclatural code when known, else None — available on every variant (Java code()).

Source

pub fn parsed(&self) -> Option<&ParsedName>

The parsed name if this is ParseResult::Parsed, else None (Java parsed()). ParseResult::Informal and ParseResult::Unparsable carry no ParsedName.

Source

pub fn is_parsable(&self) -> bool

True iff this carries a structured ParsedName — i.e. is a ParseResult::Parsed (Java isParsable()).

Trait Implementations§

Source§

impl Clone for ParseResult

Source§

fn clone(&self) -> Self

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 ParseResult

Source§

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

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

impl Eq for ParseResult

Source§

impl PartialEq for ParseResult

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ParseResult

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

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.