Crate locspan

This library provides essentials types and trait to locate syntax elements.

• Span describes a byte range in a source file, with an intuitive API to write lexers and parsers.
• Location<F> combines a Span with a file identifier F to pin point a syntactic element in a source file.
• Meta<T, M> wraps any value T with some metadata of type M.
• Loc<T, F, S> = Meta<T, Location<F, S>> wraps any value T and with its location.

Extra traits are also provided to extend common types (Option, Result, etc.) with localization functions. The crate integrates well with diagnostic reporting libraries such as codespan-reporting to render beautiful error reports.

Structs

• Location
  Syntax element location.
• Meta
  Data and its metadata.
• Span
  Range of bytes in a source file.
• Stripped
  Wrapper to consider values without metadata.

Traits

• At
  Provides the at function to locate any value.
• BorrowStripped
• ErrAt
  Locates the error of a Result<T, E>.
• Located
  Value with a location.
• MapLocErr
  Maps the located error of a Result<T, Meta<E, F>>.
• MapMetadataRecursively
  Provides a function to map the metadata inside a recursive data structure.
• MaybeLocated
  Value with an optional location.
• MaybeSpanned
  Value with an optional span.
• MaybeSpannedMut
  Value with an optional span.
• MetaTranspose
  Provides a transposition function from Option<Meta<T, M>> to Meta<Option<T>, M>.
• Spanned
  Value with a span.
• SpannedMut
  Value with a mutable span.
• Strip
  Type that can be stripped of its metadata.
• StrippedEq
  Defines the total equality of values without considering metadata.
• StrippedHash
  Defines the partial ordering of located values without considering locations.
• StrippedOrd
  Defines the partial ordering of located values without considering locations.
• StrippedPartialEq
  Defines the equality of values without considering the metadata.
• StrippedPartialOrd
  Defines the partial ordering of located values without considering locations.
• TryMapMetadataRecursively
  Provides a function that tries to map the metadata inside a recursive data structure.

Type Aliases

• Loc
  Data with Location metadata.