Struct Context 

pub struct Context { /* private fields */ }

Available on crate feature reqsign only.

Context provides the context for the request signing.

Important

reqsign provides NO default implementations. Users MAY configure components they need. Any unconfigured component will use a no-op implementation that returns errors or empty values when called.

Example

use reqsign_core::{Context, OsEnv};

// Create a context with explicit implementations
let ctx = Context::new()
    .with_env(OsEnv);  // Optionally configure environment implementation

Implementations

impl Context

pub fn new() -> Context

Create a new Context with no-op implementations.

All components use no-op implementations by default. Use the with_* methods to configure the components you need.

use reqsign_core::Context;

let ctx = Context::new();
// All components use no-op implementations by default
// You can configure specific components as needed:
// ctx.with_file_read(my_file_reader)
//    .with_http_send(my_http_client)
//    .with_env(my_env_provider);

pub fn with_file_read(self, fs: impl FileRead) -> Context

Replace the file reader implementation.

pub fn with_http_send(self, http: impl HttpSend) -> Context

Replace the HTTP client implementation.

pub fn with_env(self, env: impl Env) -> Context

Replace the environment implementation.

pub fn with_command_execute(self, cmd: impl CommandExecute) -> Context

Replace the command executor implementation.

pub async fn file_read(&self, path: &str) -> Result<Vec<u8>, Error>

Read the file content entirely in Vec<u8>.

pub async fn file_read_as_string(&self, path: &str) -> Result<String, Error>

Read the file content entirely in String.

pub async fn http_send( &self, req: Request<Bytes>, ) -> Result<Response<Bytes>, Error>

Send http request and return the response.

pub async fn http_send_as_string( &self, req: Request<Bytes>, ) -> Result<Response<String>, Error>

Send http request and return the response as string.

pub fn home_dir(&self) -> Option<PathBuf>

Get the home directory of the current user.

pub fn expand_home_dir(&self, path: &str) -> Option<String>

Expand ~ in input path.

• If path not starts with ~/ or ~\\, returns Some(path) directly.
• Otherwise, replace ~ with home dir instead.
• If home_dir is not found, returns None.

pub fn env_var(&self, key: &str) -> Option<String>

Get the environment variable.

• Returns Some(v) if the environment variable is found and is valid utf-8.
• Returns None if the environment variable is not found or value is invalid.

pub fn env_vars(&self) -> HashMap<String, String>

Returns a hashmap of (variable, value) pairs of strings, for all the environment variables of the current process.

pub async fn command_execute( &self, program: &str, args: &[&str], ) -> Result<CommandOutput, Error>

Execute an external command with the given program and arguments.

Returns the command output including exit status, stdout, and stderr.

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Context

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

Formats the value using the given formatter.

impl Default for Context

fn default() -> Context

Returns the “default value” for a type.