Skip to main content

parse_name

Function parse_name 

Source
pub fn parse_name(
    name: &str,
    authorship: Option<&str>,
    rank: Option<Rank>,
    code: Option<NomCode>,
) -> Result<ParsedName, ParseError>
Expand description

The lower-level raw parse: a scientific name — optionally alongside a separately supplied authorship string, a requested Rank and a requested NomCode — into a ParsedName, or Err(ParseError) when the input cannot be parsed into a meaningful name. Delegates to pipeline::run.

This is the raw ParsedName/error path — informal names come back as Ok(ParsedName) with type == INFORMAL, NOT split off. It backs the golden snapshot, the FFI/CLI/R encoders (which need the full ParsedName and derive the three-way at their own boundary), and any caller that wants the structured atoms directly. Most callers want parse instead — the primary 5.0.0 exceptionless entry point that returns the three-way ParseResult.