Enum h3ron::error::Error

pub enum Error {
    Failed,
    Domain,
    LatLonDomain,
    ResDomain,
    CellInvalid,
    DirectedEdgeInvalid,
    UndirectedEdgeInvalid,
    VertexInvalid,
    Pentagon,
    DuplicateInput,
    NotNeighbors,
    ResMismatch,
    MemoryAlloc,
    MemoryBounds,
    OptionInvalid,
    UnknownError(u32),
    DirectionInvalid(u8),
    DecompressionError(String),
}

Errors as defines in RFC 4.0.0, extended with some custom errors of this wrapper library.

Variants

Failed

The operation failed but a more specific error is not available

Domain

Argument was outside of acceptable range (when a more specific error code is not available)

LatLonDomain

Latitude or longitude arguments were outside of acceptable range

ResDomain

Resolution argument was outside of acceptable range

CellInvalid

H3Index cell argument was not valid

DirectedEdgeInvalid

H3Index directed edge argument was not valid

UndirectedEdgeInvalid

H3Index undirected edge argument was not valid

VertexInvalid

H3Index vertex argument was not valid

Pentagon

Pentagon distortion was encountered which the algorithm could not handle it

DuplicateInput

Duplicate input was encountered in the arguments and the algorithm could not handle it

NotNeighbors

H3Index cell arguments were not neighbors

ResMismatch

H3Index cell arguments had incompatible resolutions

MemoryAlloc

Necessary memory allocation failed

MemoryBounds

Bounds of provided memory were not large enough

OptionInvalid

Mode or flags argument was not valid.

UnknownError(u32)

Unknown error code

DirectionInvalid(u8)

Invalid H3 direction

DecompressionError(String)

Implementations

impl Error

pub const fn is_error(value: u32) -> bool

Checks if the H3 return value is an error

pub const fn check_returncode(value: u32) -> Result<(), Self>

checks the return code of h3ron-h3-sys functions

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide(&'a self, req: &mut Demand<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type based access to context intended for error reports.