Struct Request

pub struct Request {
    pub version: Version,
    pub required: Required,
    pub optional: HashMap<String, Value>,
}

Signing request.

Fields

version: Version

Version of this signing request.

required: Required

Required parameters of the signing process.

All required parameters must be understood by the signing process or the entire request is to be rejected.

optional: HashMap<String, Value>

Optional parameters for the signing process.

The server may ignore any or all parameters in this group. If any parameter is not understood by the server it must be ignored.

Implementations

impl Request

pub fn from_reader(reader: impl Read) -> Result<Self, Error>

Read the request from a JSON serialized bytes.

Errors

Returns an error if reading the file fails or the file contents are not well-formed.

pub fn to_writer(&self, writer: impl Write) -> Result<(), Error>

Write the request as a JSON serialized form.

Errors

Returns an error if serialization of the request fails or writing to the writer encounters an error.

pub fn for_file(input: impl AsRef<Path>) -> Result<Self, Error>

Prepares a signing request for a file.

Given a file as an input this function creates a well-formed request. That request is of latest known version and contains all necessary fields.

Errors

Returns an error if reading the file fails or forming the request encounters an error.

Examples

The following example creates a signing request for Cargo.toml:

use signstar_request_signature::Request;

let signing_request = Request::for_file("Cargo.toml")?;

Trait Implementations

impl Debug for Request

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Request

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Request

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

where __S: Serializer,

Serialize this value into the given Serde serializer.