Haystack

View Source Haystack.Tokenizer.Token (Haystack v0.1.0)

A module for Tokens.

Link to this section Summary

Types

opts()
t()
v()

Functions

new(v, opts)

Create a new token.

Link to this section Types

Link to this type

opts()

View Source 
@type opts() :: [offset: integer(), length: integer()]
Link to this type

t()

View Source 
@type t() :: %Haystack.Tokenizer.Token{length: integer(), offset: integer(), v: v()}
Link to this type

v()

View Source 
@type v() :: String.t()

Link to this section Functions

Link to this function

new(v, opts)

View Source 
@spec new(String.t(), opts()) :: t()

Create a new token.

examples

 Examples 

iex> Token.new("abc", offset: 0, length: 3)