Struct Text 

pub struct Text { /* private fields */ }

Text detection result with content and metadata.

Implementations

impl Text

pub fn with_text(self, x: &str) -> Self

Sets the text field from a string slice.

Arguments

• x - A string slice that will be converted to String

Returns

Returns Self for method chaining.

Example

let obj = Text::default().with_text("value");

---

Generated by aksr - Builder pattern macro

pub fn text(&self) -> &str

Returns a string slice of the text field.

Example

let obj = Text::default();
let value = obj.text();

---

Generated by aksr - Builder pattern macro

pub fn into_text(self) -> String

Consumes self and returns the text field.

This method moves the owned value out of the struct without cloning.

Returns

Returns the owned value of type String.

Example

let obj = Text::default().with_text(value);
let value = obj.into_text();
// obj is now consumed and cannot be used

---

Generated by aksr - Builder pattern macro

pub fn take_text(&mut self) -> String

where String: Default,

Takes the text field and replaces it with Default::default().

This method moves the value out and replaces it with the default value, allowing you to continue using the struct.

Returns

Returns the owned value of type String.

Note

Requires the field type String to implement Default. Prefer this when you want to keep using the instance.

Example

let mut obj = Text::default().with_text(value);
let value = obj.take_text();
// obj.text is now set to Default::default()

---

Generated by aksr - Builder pattern macro

pub fn with_meta(self, x: InstanceMeta) -> Self

Sets the meta field.

Arguments

• x - The new value to be assigned

Returns

Returns Self for method chaining.

Example

let obj = Text::default().with_meta(value);

---

Generated by aksr - Builder pattern macro

pub fn meta(&self) -> &InstanceMeta

Returns a reference to the meta field.

Example

let obj = Text::default();
let value = obj.meta();

---

Generated by aksr - Builder pattern macro

pub fn into_meta(self) -> InstanceMeta

Consumes self and returns the meta field.

This method moves the owned value out of the struct without cloning.

Returns

Returns the owned value of type InstanceMeta.

Example

let obj = Text::default().with_meta(value);
let value = obj.into_meta();
// obj is now consumed and cannot be used

---

Generated by aksr - Builder pattern macro

pub fn with_style(self, x: TextStyle) -> Self

Sets the optional style field.

Arguments

• x - The value that will be automatically wrapped in Some

Returns

Returns Self for method chaining.

Note

The value is automatically wrapped in Some, so you don’t need to pass Some(value).

Example

let obj = Text::default().with_style(value);

---

Generated by aksr - Builder pattern macro

pub fn style(&self) -> Option<&TextStyle>

Returns an optional reference to the style field.

Example

let obj = Text::default();
let value = obj.style();

---

Generated by aksr - Builder pattern macro

pub fn into_style(self) -> Option<TextStyle>

Consumes self and returns the style field.

This method moves the owned value out of the struct without cloning.

Returns

Returns Option containing the field value, or None if the field was None.

Example

let obj = Text::default().with_style(value);
let value = obj.into_style();

---

Generated by aksr - Builder pattern macro

pub fn take_style(&mut self) -> Option<TextStyle>

Takes the style field, leaving None in its place.

This method moves the value out and replaces it with None, allowing you to continue using the struct.

Returns

Returns Option containing the field value, or None if the field was None.

Note

This does not require the inner type to implement Default.

Example

let mut obj = Text::default().with_style(value);
let value = obj.take_style();
// obj.style is now None

---

Generated by aksr - Builder pattern macro

impl Text

pub fn with_track_id(self, track_id: usize) -> Self

pub fn track_id(&self) -> Option<usize>

pub fn with_uid(self, uid: usize) -> Self

pub fn with_id(self, id: usize) -> Self

pub fn with_name(self, name: &str) -> Self

pub fn with_confidence(self, confidence: f32) -> Self

pub fn uid(&self) -> usize

pub fn name(&self) -> Option<&str>

pub fn confidence(&self) -> Option<f32>

pub fn id(&self) -> Option<usize>

Trait Implementations

impl Clone for Text

fn clone(&self) -> Text

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Text

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

Formats the value using the given formatter.

impl Default for Text

fn default() -> Text

Returns the “default value” for a type.

impl From<&str> for Text

fn from(text: &str) -> Self

Converts to this type from the input type.

impl From<String> for Text

fn from(text: String) -> Self

Converts to this type from the input type.