Struct SanitizationResult 

#[non_exhaustive]
pub struct SanitizationResult {
    pub filter_match_state: FilterMatchState,
    pub filter_results: HashMap<String, FilterResult>,
    pub invocation_result: InvocationResult,
    pub sanitization_metadata: Option<SanitizationMetadata>,
    /* private fields */
}

Sanitization result after applying all the filters on input content.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

filter_match_state: FilterMatchState

Output only. Overall filter match state for Sanitization. The state can have below two values.

1. NO_MATCH_FOUND: No filters in configuration satisfy matching criteria. In other words, input passed all filters.

2. MATCH_FOUND: At least one filter in configuration satisfies matching. In other words, input did not pass one or more filters.

filter_results: HashMap<String, FilterResult>

Output only. Results for all filters where the key is the filter name - either of “csam”, “malicious_uris”, “rai”, “pi_and_jailbreak” ,“sdp”.

invocation_result: InvocationResult

Output only. A field indicating the outcome of the invocation, irrespective of match status. It can have the following three values: SUCCESS: All filters were executed successfully. PARTIAL: Some filters were skipped or failed execution. FAILURE: All filters were skipped or failed execution.

sanitization_metadata: Option<SanitizationMetadata>

Output only. Metadata related to Sanitization.

Implementations

impl SanitizationResult

pub fn new() -> Self

pub fn set_filter_match_state<T: Into<FilterMatchState>>(self, v: T) -> Self

Sets the value of filter_match_state.

pub fn set_filter_results<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<FilterResult>,

Sets the value of filter_results.

pub fn set_invocation_result<T: Into<InvocationResult>>(self, v: T) -> Self

Sets the value of invocation_result.

pub fn set_sanitization_metadata<T>(self, v: T) -> Self

where T: Into<SanitizationMetadata>,

Sets the value of sanitization_metadata.

pub fn set_or_clear_sanitization_metadata<T>(self, v: Option<T>) -> Self

where T: Into<SanitizationMetadata>,

Sets or clears the value of sanitization_metadata.

Trait Implementations

impl Clone for SanitizationResult

fn clone(&self) -> SanitizationResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SanitizationResult

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

Formats the value using the given formatter.

impl Default for SanitizationResult

fn default() -> SanitizationResult

Returns the “default value” for a type.

impl Message for SanitizationResult

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SanitizationResult

fn eq(&self, other: &SanitizationResult) -> 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 StructuralPartialEq for SanitizationResult