Struct barc::Record

pub struct Record {
    pub rec_type: RecordType,
    pub meta: HeaderMap,
    pub req_headers: HeaderMap,
    pub req_body: BodyImage,
    pub res_headers: HeaderMap,
    pub res_body: BodyImage,
}

An owned BARC record with public fields.

Additonal getter methods are found in trait implementations RequestRecorded, Recorded, and MetaRecorded.

Fields

rec_type: RecordType

Record type.

meta: HeaderMap

Map of meta-headers for values which are not strictly part of the HTTP request or response headers. This can be extended with application specific name/value pairs.

req_headers: HeaderMap

Map of HTTP request headers.

req_body: BodyImage

Request body which may or may not be RAM resident.

res_headers: HeaderMap

Map of HTTP response headers.

res_body: BodyImage

Response body which may or may not be RAM resident.

Trait Implementations

impl Clone for Record

fn clone(&self) -> Record

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Record

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

Formats the value using the given formatter.

impl Default for Record

fn default() -> Record

Returns the "default value" for a type.

impl MetaRecorded for Record

fn rec_type(&self) -> RecordType

Record type.

fn meta(&self) -> &HeaderMap

Map of meta-headers for values which are not strictly part of the HTTP request or response headers.

impl Recorded for Record

fn res_headers(&self) -> &HeaderMap

Map of HTTP response headers.

fn res_body(&self) -> &BodyImage

Response body which may or may not be RAM resident.

impl RequestRecorded for Record

fn req_headers(&self) -> &HeaderMap

Map of HTTP request headers.

fn req_body(&self) -> &BodyImage

Request body (e.g for HTTP POST, etc.) which may or may not be RAM resident.

impl TryFrom<Dialog> for Record

type Error = BarcError

The type returned in the event of a conversion error.

fn try_from(dialog: Dialog) -> Result<Self, Self::Error>

Attempt to convert Dialog to Record. This derives meta headers from various Dialog fields, and could potentially fail, based on header value constraints, with BarcError::InvalidHeader. Converting Dialog::url to the meta url header has the most potential, given http::Uri validation complexity, but any conversion failure would suggest an http crate bug or breaking change—as currently stated, allowed Uri bytes are a subset of allowed HeaderValue bytes.

impl TryFrom<Record> for Dialog

type Error = DialogConvertError

The type returned in the event of a conversion error.

fn try_from(rec: Record) -> Result<Self, Self::Error>

Attempt to convert Record to Dialog. This parses various meta header values to produce Dialog equivalents such as http::StatusCode and http::Method, which could fail, if the Record was not originally produced from a Dialog or was otherwise modified in an unsupported way.