annotations v0.1.0 Annotations.AnnotatedString

splits the Annotated string in two. Each String keeps the Annotations referring to itsaelf. Annotations spanning split boundaries are duplicated to each neighboring chunk

split_at(annotated_string, where)

split_by_annotation(ann_str, fun, options \\ [])

Splits a AnnotatedString at any point within an annotation. fun is a fn str, ann-> nil|:before|:after|integer, where integer is between ann.from and ann.to

split_by_tags(str, tags)

split_by_tags(str, tags, options)

splits the string at the before or after annotations tagged with any tag in tags options: split: (:before | :after) For a general function for splitting based on Annotations look at split_by_annotation/3

starts_with?(arg, arg2)

tag_all(arg, re, tag \\ :default)

to_charlist(arg)

to_float(arg)

to_integer(arg, arg2)

to_string(annotated_string)

trim_leading(ann_str, to_trim \\ nil)

upcase(arg)

valid?(arg)

Link to this section Functions

add_annotations(str, annotations)

capitalize(arg)

contains?(arg, arg2)

disjoint?(annotated_string, consider \\ nil)

Tests whether the annotations in the AnnotatedString are disjoint. consider can be any of the values allowed by Annotations.List.disjoint?/2

downcase(arg)

ends_with?(arg, arg2)

equivalent?(arg, arg2)

extract_annotations(str, tags)

extract_annotations(str, tags, options)

jaro_distance(arg, arg2)

join(enum, joiner \\ __MODULE__.new(" ", Annotation.new(0, 1, :joiner)))

Joins the given enumerable into a binary using joiner as a separator.

If joiner is not passed at all, it defaults to %AnnotatedString(“ “, Annotation.new(0, 1, :joiner)).

All items in the enumerable and the joiner must be AnnotatedStrings or Strings, otherwise an error is raised.

length(arg)

new(str)

new(str, annotations)

next_grapheme_size(arg)

normalize(arg, arg2)

printable?(arg)

select_annotation_ranges(annotated_string, fun \\ nil)

split(arg)

split(annotated_string, splitter, orig_options \\ [])