Struct Tagged 

pub struct Tagged { /* private fields */ }

A line of text with tags.

Implementations

impl Tagged

pub fn new(text: &[u8]) -> Tagged

Create a new Tagged container for a slice of text.

This container holds the original text and will collect any Tags found within it.

pub fn tag(self, tag: Tag) -> Self

Adds a tag to this text.

The tag should contain a range that corresponds to its position in self.text().

pub fn tags(&self) -> &[Tag]

Get the tags in this text.

pub fn text(&self) -> &[u8]

Get the original text.

pub fn set_text_data(&mut self, data: TextData)

Explicitly sets the text data used for JSON serialization.

pub fn write<W: Write>(&self, wtr: &mut W) -> Result<()>

Writes the text to the given writer, replacing tagged IPs with their decorated versions.

If a tag has a decorated() value, that value is written instead of the original bytes in its range(). If no decoration is present, the original bytes are written.

Tags MUST be sorted by their start position for this to work correctly.

pub fn write_json<W: Write + ?Sized>(&mut self, wtr: &mut W) -> Result<()>

Writes the Tagged object as a JSON object to the given writer.

This is useful for exporting structured metadata about the IPs found in the text.

Trait Implementations

impl Clone for Tagged

fn clone(&self) -> Tagged

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Tagged

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

Formats the value using the given formatter.

impl Serialize for Tagged

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.