Struct relay_protocol::Remark

pub struct Remark {
    pub ty: RemarkType,
    pub rule_id: String,
    pub range: Option<Range>,
}

Information on a modified section in a string.

Fields

ty: RemarkType

The kind of redaction that has been applied on the target value.

rule_id: String

Unique identifier of the data scrubbing or normalization rule that caused the modification.

range: Option<Range>

The inclusive start and exclusive end indices of this remark.

Implementations

impl Remark

pub fn new<S: Into<String>>(ty: RemarkType, rule_id: S) -> Self

Creates a new remark.

pub fn with_range<S: Into<String>>( ty: RemarkType, rule_id: S, range: Range, ) -> Self

Creates a new text remark with range indices.

pub fn rule_id(&self) -> &str

The note of this remark.

pub fn range(&self) -> Option<&Range>

The range of this remark.

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

The length of this range.

pub fn is_empty(&self) -> bool

Indicates if the remark refers to an empty range

pub fn ty(&self) -> RemarkType

Returns the type.

Trait Implementations

impl Clone for Remark

fn clone(&self) -> Remark

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Remark

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Remark

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq for Remark

fn eq(&self, other: &Remark) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Remark

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Remark