Struct Http

pub struct Http<'lua>(/* private fields */);

The “Http” class contain all the HTTP manipulation functions.

Implementations

impl<'lua> Http<'lua>

pub fn req_get_headers(&self) -> Result<Headers<'lua>>

Returns a Headers table containing all the request headers.

pub fn res_get_headers(&self) -> Result<Headers<'lua>>

Returns a Headers table containing all the response headers.

pub fn req_add_header<V: IntoLua<'lua>>( &self, name: &str, value: V, ) -> Result<()>

Appends an HTTP header field name with value in the request.

pub fn res_add_header<V: IntoLua<'lua>>( &self, name: &str, value: V, ) -> Result<()>

Appends an HTTP header field name with value in the response.

pub fn req_del_header(&self, name: &str) -> Result<()>

Removes all HTTP header fields in the request by name.

pub fn res_del_header(&self, name: &str) -> Result<()>

Removes all HTTP header fields in the response by name.

pub fn req_set_header<V: IntoLua<'lua>>( &self, name: &str, value: V, ) -> Result<()>

Replaces all occurrence of HTTP request header name, by only one containing the value.

pub fn res_set_header<V: IntoLua<'lua>>( &self, name: &str, value: V, ) -> Result<()>

Replaces all occurrence of HTTP response header name, by only one containing the value.

pub fn req_rep_header( &self, name: &str, regex: &str, replace: &str, ) -> Result<()>

Matches the regular expression in all occurrences of HTTP request header name according to regex, and replaces them with the replace argument.

The replacement value can contain back references like 1, 2, …

pub fn res_rep_header( &self, name: &str, regex: &str, replace: &str, ) -> Result<()>

Matches the regular expression in all occurrences of HTTP response header name according to regex, and replaces them with the replace argument.

The replacement value can contain back references like 1, 2, …

pub fn req_set_method(&self, method: &str) -> Result<()>

Rewrites the request method with the method.

pub fn req_set_path(&self, path: &str) -> Result<()>

Rewrites the request path with the path.

pub fn req_set_query(&self, query: &str) -> Result<()>

Rewrites the request’s query string which appears after the first question mark (?) with the query.

pub fn req_set_uri(&self, uri: &str) -> Result<()>

Rewrites the request URI with the uri.

pub fn res_set_status(&self, status: u16, reason: Option<&str>) -> Result<()>

Rewrites the response status code. If no custom reason is provided, it will be generated from the status.

Methods from Deref<Target = Table<'lua>>

pub fn set<K, V>(&self, key: K, value: V) -> Result<(), Error>

where K: IntoLua<'lua>, V: IntoLua<'lua>,

Sets a key-value pair in the table.

If the value is nil, this will effectively remove the pair.

This might invoke the __newindex metamethod. Use the raw_set method if that is not desired.

Examples

Export a value as a global to make it usable from Lua:

let globals = lua.globals();

globals.set("assertions", cfg!(debug_assertions))?;

lua.load(r#"
    if assertions == true then
        -- ...
    elseif assertions == false then
        -- ...
    else
        error("assertions neither on nor off?")
    end
"#).exec()?;

pub fn get<K, V>(&self, key: K) -> Result<V, Error>

where K: IntoLua<'lua>, V: FromLua<'lua>,

Gets the value associated to key from the table.

If no value is associated to key, returns the nil value.

This might invoke the __index metamethod. Use the raw_get method if that is not desired.

Examples

Query the version of the Lua interpreter:

let globals = lua.globals();

let version: String = globals.get("_VERSION")?;
println!("Lua version: {}", version);

pub fn contains_key<K>(&self, key: K) -> Result<bool, Error>

where K: IntoLua<'lua>,

Checks whether the table contains a non-nil value for key.

This might invoke the __index metamethod.

pub fn push<V>(&self, value: V) -> Result<(), Error>

where V: IntoLua<'lua>,

Appends a value to the back of the table.

This might invoke the __len and __newindex metamethods.

pub fn pop<V>(&self) -> Result<V, Error>

where V: FromLua<'lua>,

Removes the last element from the table and returns it.

This might invoke the __len and __newindex metamethods.

pub fn equals<T>(&self, other: T) -> Result<bool, Error>

where T: AsRef<Table<'lua>>,

Compares two tables for equality.

Tables are compared by reference first. If they are not primitively equals, then mlua will try to invoke the __eq metamethod. mlua will check self first for the metamethod, then other if not found.

Examples

Compare two tables using __eq metamethod:

let table1 = lua.create_table()?;
table1.set(1, "value")?;

let table2 = lua.create_table()?;
table2.set(2, "value")?;

let always_equals_mt = lua.create_table()?;
always_equals_mt.set("__eq", lua.create_function(|_, (_t1, _t2): (Table, Table)| Ok(true))?)?;
table2.set_metatable(Some(always_equals_mt));

assert!(table1.equals(&table1.clone())?);
assert!(table1.equals(&table2)?);

pub fn raw_set<K, V>(&self, key: K, value: V) -> Result<(), Error>

where K: IntoLua<'lua>, V: IntoLua<'lua>,

Sets a key-value pair without invoking metamethods.

pub fn raw_get<K, V>(&self, key: K) -> Result<V, Error>

where K: IntoLua<'lua>, V: FromLua<'lua>,

Gets the value associated to key without invoking metamethods.

pub fn raw_insert<V>(&self, idx: i64, value: V) -> Result<(), Error>

where V: IntoLua<'lua>,

Inserts element value at position idx to the table, shifting up the elements from table[idx]. The worst case complexity is O(n), where n is the table length.

pub fn raw_push<V>(&self, value: V) -> Result<(), Error>

where V: IntoLua<'lua>,

Appends a value to the back of the table without invoking metamethods.

pub fn raw_pop<V>(&self) -> Result<V, Error>

where V: FromLua<'lua>,

Removes the last element from the table and returns it, without invoking metamethods.

pub fn raw_remove<K>(&self, key: K) -> Result<(), Error>

where K: IntoLua<'lua>,

Removes a key from the table.

If key is an integer, mlua shifts down the elements from table[key+1], and erases element table[key]. The complexity is O(n) in the worst case, where n is the table length.

For other key types this is equivalent to setting table[key] = nil.

pub fn clear(&self) -> Result<(), Error>

Clears the table, removing all keys and values from array and hash parts, without invoking metamethods.

This method is useful to clear the table while keeping its capacity.

pub fn len(&self) -> Result<i64, Error>

Returns the result of the Lua # operator.

This might invoke the __len metamethod. Use the raw_len method if that is not desired.

pub fn raw_len(&self) -> usize

Returns the result of the Lua # operator, without invoking the __len metamethod.

pub fn is_empty(&self) -> bool

Returns true if the table is empty, without invoking metamethods.

It checks both the array part and the hash part.

pub fn get_metatable(&self) -> Option<Table<'lua>>

Returns a reference to the metatable of this table, or None if no metatable is set.

Unlike the getmetatable Lua function, this method ignores the __metatable field.

pub fn set_metatable(&self, metatable: Option<Table<'lua>>)

Sets or removes the metatable of this table.

If metatable is None, the metatable is removed (if no metatable is set, this does nothing).

pub fn to_pointer(&self) -> *const c_void

Converts this table to a generic C pointer.

Different tables will give different pointers. There is no way to convert the pointer back to its original value.

Typically this function is used only for hashing and debug information.

pub fn for_each<K, V>( &self, f: impl FnMut(K, V) -> Result<(), Error>, ) -> Result<(), Error>

where K: FromLua<'lua>, V: FromLua<'lua>,

Iterates over the pairs of the table, invoking the given closure on each pair.

This method is similar to Table::pairs, but optimized for performance. It does not invoke the __pairs metamethod.

Trait Implementations

impl<'lua> Clone for Http<'lua>

fn clone(&self) -> Http<'lua>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'lua> Deref for Http<'lua>

type Target = Table<'lua>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'lua> FromLua<'lua> for Http<'lua>

fn from_lua(value: Value<'lua>, lua: &'lua Lua) -> Result<Self>

Performs the conversion.