Struct aws_lambda_runtime_proxy::Proxy

pub struct Proxy {
    pub port: Option<u16>,
    pub command: Option<Command>,
}

Fields

port: Option<u16>

See Self::port.

command: Option<Command>

See Self::command.

Implementations

impl Proxy

pub fn default_command() -> Command

Create the handler command from the argv[1..]. For example if the command of the current process is proxy node --help then the handler command will be node --help. You can modify the handler command and pass it to Self::command.

Examples

use lambda_runtime_proxy::Proxy;
use std::process::Stdio;

#[tokio::main]
async fn main {
  // retrieve the default handler command
  let mut command = Proxy::default_command();

  // enhance the handler command
  command
    // override environment variables for the handler process
    .env("KEY", "VALUE")
    // pipe the stdout and stderr of the handler process
    .stdout(Stdio::piped())
    .stderr(Stdio::piped());

  Proxy::default()
    .command(command)
    .spawn().await;
}

Examples found in repository

examples/modify_handler_process.rs (line 6)

async fn main() {
  let mut handler = Proxy::default_command()
    // capture stdout
    .stdout(Stdio::piped())
    // override environment variables for the handler process
    .env("KEY", "VALUE")
    // pass additional arguments to the handler process
    .arg("--help")
    .spawn()
    .unwrap();

  // take the stdout
  let _stdout = handler.stdout.take().unwrap();
  // do something with the stdout

  // wait until the handler process exits
  handler.wait().await.unwrap();
}

pub fn port(self, port: u16) -> Self

Set the port of the proxy server. If not set, the port will be read from the environment variable AWS_LAMBDA_RUNTIME_PROXY_PORT, or default to 3000.

pub fn command(self, cmd: Command) -> Self

Set the command of the handler process. If not set, the command will be created using Self::default_command.

pub async fn spawn<ReqBody: Body + Send + 'static>( self ) -> RunningProxy<ReqBody>

where ReqBody::Data: Send, ReqBody::Error: Into<Box<dyn Error + Send + Sync>>,

Spawn the proxy server, lambda runtime api client and the handler process. The handler process will be spawned with the environment variable AWS_LAMBDA_RUNTIME_API set to the address of the proxy server.

Examples found in repository

examples/hello_world.rs (line 5)

async fn main() {
  let proxy = Proxy::default().spawn().await;
  // equals to:
  // let proxy = Proxy::default()
  //   .port(3000)
  //   .command(Proxy::default_command())
  //   .spawn()
  //   .await;

  proxy.server.passthrough(proxy.client).await;
}

Trait Implementations

impl Default for Proxy

fn default() -> Proxy

Returns the “default value” for a type.