Struct SearchRequestParameters 

pub struct SearchRequestParameters {
    pub partial_hash: Option<(PartialHashSearchType, String)>,
    pub file_name: Option<String>,
    pub limit: u32,
    pub file_type: Option<String>,
    pub magic: Option<String>,
    pub labels: Option<Vec<String>>,
    pub response: PartialHashSearchType,
}

Search for a file by some criteria, all of which are an AND operation:

• Partial hash
• Name of the sample
• Type of the sample
• Libmagic description of the sample
• Labels applied to the sample

Fields

partial_hash: Option<(PartialHashSearchType, String)>

Search for a file by partial hash

file_name: Option<String>

Search for a file by whole or partial file name

limit: u32

Maximum number of results to return, 100 results or fewer.

file_type: Option<String>

Optionally search for samples of a specific file type.

magic: Option<String>

Optionally search for samples based on libmagic, also known as the file command.

labels: Option<Vec<String>>

Optionally search for samples with specific label(s).

response: PartialHashSearchType

Get the returned result by a hash type. PartialHashSearchType::Any results in SHA-256

Implementations

impl SearchRequestParameters

pub fn is_valid(&self) -> bool

Ensure the search request is valid:

• The partial hash is valid hexidecimal, if present
• At least one search parameter is provided
• The limit must be greater than zero

Trait Implementations

impl Clone for SearchRequestParameters

fn clone(&self) -> SearchRequestParameters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchRequestParameters

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

Formats the value using the given formatter.

impl Default for SearchRequestParameters

This trait implementation is provided as a convenience. This does not create a valid object.

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SearchRequestParameters

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SearchRequestParameters

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SearchRequestParameters

impl StructuralPartialEq for SearchRequestParameters