Struct HTTPLibrary

pub struct HTTPLibrary {
    pub agent: Agent,
}

Fields

agent: Agent

Trait Implementations

impl Debug for HTTPLibrary

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

Formats the value using the given formatter.

impl Default for HTTPLibrary

fn default() -> Self

Returns the “default value” for a type.

impl Library for HTTPLibrary

fn scope(&self) -> String

Scope of this library. This is how this library is invoked from Stof. Ex. HTTP.get('https://example.com')

fn call( &self, pid: &str, doc: &mut SDoc, name: &str, parameters: &mut Vec<SVal>, ) -> Result<SVal, SError>

Call an HTTP method in this library.

Supported functions:

• HTTP.get
• HTTP.head
• HTTP.patch
• HTTP.post
• HTTP.put
• HTTP.delete

Parameters (in order) for each call:

• url: str - The HTTP request path (REQUIRED)
• headers: vec[(str, str)] | map - The request headers (OPTIONAL)
• body: str | blob - The request body (OPTIONAL)
• timeout: float | units - The overall timeout for the request (OPTIONAL) (default 5 seconds - use time units as needed)
• response_obj: obj - A response object to parse the response into via doc.header_import with the content type (OPTIONAL)

Basic GET request: HTTP.get('https://example.com')

POST request with a body: HTTP.post('https://example.com', 'this is a string body to send')

POST request json body and a timeout: HTTP.post('https://example.com', map(('content-type', 'application/json')), stringify(self, 'json'), 10s)