Struct ApiDetails

pub struct ApiDetails {

    pub name: Option<String>,
    pub bucket: Option<String>,
    pub object: Option<String>,
    pub objects: Vec<ObjectVersion>,
    pub status: Option<String>,
    pub status_code: Option<i32>,
    pub input_bytes: i64,
    pub output_bytes: i64,
    pub header_bytes: Option<i64>,
    pub time_to_first_byte: Option<String>,
    pub time_to_first_byte_in_ns: Option<String>,
    pub time_to_response: Option<String>,
    pub time_to_response_in_ns: Option<String>,
}

API details structure ApiDetails is used to define the details of an API operation

The ApiDetails structure contains the following fields:

• name - the name of the API operation
• bucket - the bucket name
• object - the object name
• objects - the list of objects
• status - the status of the API operation
• status_code - the status code of the API operation
• input_bytes - the input bytes
• output_bytes - the output bytes
• header_bytes - the header bytes
• time_to_first_byte - the time to first byte
• time_to_first_byte_in_ns - the time to first byte in nanoseconds
• time_to_response - the time to response
• time_to_response_in_ns - the time to response in nanoseconds

The ApiDetails structure contains the following methods:

• new - create a new ApiDetails with default values
• set_name - set the name
• set_bucket - set the bucket
• set_object - set the object
• set_objects - set the objects
• set_status - set the status
• set_status_code - set the status code
• set_input_bytes - set the input bytes
• set_output_bytes - set the output bytes
• set_header_bytes - set the header bytes
• set_time_to_first_byte - set the time to first byte
• set_time_to_first_byte_in_ns - set the time to first byte in nanoseconds
• set_time_to_response - set the time to response
• set_time_to_response_in_ns - set the time to response in nanoseconds

Example

use rustfs_obs::ApiDetails;
use rustfs_obs::ObjectVersion;

let api = ApiDetails::new()
    .set_name(Some("GET".to_string()))
    .set_bucket(Some("my-bucket".to_string()))
    .set_object(Some("my-object".to_string()))
    .set_objects(vec![ObjectVersion::new_with_object_name("my-object".to_string())])
    .set_status(Some("OK".to_string()))
    .set_status_code(Some(200))
    .set_input_bytes(100)
    .set_output_bytes(200)
    .set_header_bytes(Some(50))
    .set_time_to_first_byte(Some("100ms".to_string()))
    .set_time_to_first_byte_in_ns(Some("100000000ns".to_string()))
    .set_time_to_response(Some("200ms".to_string()))
    .set_time_to_response_in_ns(Some("200000000ns".to_string()));

Fields

name: Option<String>

bucket: Option<String>

object: Option<String>

objects: Vec<ObjectVersion>

status: Option<String>

status_code: Option<i32>

input_bytes: i64

output_bytes: i64

header_bytes: Option<i64>

time_to_first_byte: Option<String>

time_to_first_byte_in_ns: Option<String>

time_to_response: Option<String>

time_to_response_in_ns: Option<String>

Implementations

impl ApiDetails

pub fn new() -> Self

Create a new ApiDetails with default values

pub fn set_name(self, name: Option<String>) -> Self

Set the name

pub fn set_bucket(self, bucket: Option<String>) -> Self

Set the bucket

pub fn set_object(self, object: Option<String>) -> Self

Set the object

pub fn set_objects(self, objects: Vec<ObjectVersion>) -> Self

Set the objects

pub fn set_status(self, status: Option<String>) -> Self

Set the status

pub fn set_status_code(self, status_code: Option<i32>) -> Self

Set the status code

pub fn set_input_bytes(self, input_bytes: i64) -> Self

Set the input bytes

pub fn set_output_bytes(self, output_bytes: i64) -> Self

Set the output bytes

pub fn set_header_bytes(self, header_bytes: Option<i64>) -> Self

Set the header bytes

pub fn set_time_to_first_byte(self, time_to_first_byte: Option<String>) -> Self

Set the time to first byte

pub fn set_time_to_first_byte_in_ns( self, time_to_first_byte_in_ns: Option<String>, ) -> Self

Set the time to first byte in nanoseconds

pub fn set_time_to_response(self, time_to_response: Option<String>) -> Self

Set the time to response

pub fn set_time_to_response_in_ns( self, time_to_response_in_ns: Option<String>, ) -> Self

Set the time to response in nanoseconds

Trait Implementations

impl Clone for ApiDetails

fn clone(&self) -> ApiDetails

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiDetails

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

Formats the value using the given formatter.

impl Default for ApiDetails

fn default() -> ApiDetails

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ApiDetails

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ApiDetails

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

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

const 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 ApiDetails

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 ApiDetails

impl StructuralPartialEq for ApiDetails