Struct haproxy_api::HttpMessage

pub struct HttpMessage<'lua> { /* private fields */ }

This class contains all functions to manipulate an HTTP message. For now, this class is only available from a filter context.

Implementations

impl<'lua> HttpMessage<'lua>

pub fn add_header(&self, name: &str, value: impl AsRef<[u8]>) -> Result<()>

Appends an HTTP header field in the HTTP message whose name is specified in name and value is defined in value.

pub fn append(&self, data: impl AsRef<[u8]>) -> Result<isize>

Copies the string at the end of incoming data of the HTTP message. The function returns the copied length on success or -1 if data cannot be copied.

pub fn body(
    &self,
    offset: Option<isize>,
    length: Option<isize>
) -> Result<Option<LuaString<'_>>>

Returns length bytes of incoming data from the HTTP message, starting at the offset. The data are not removed from the buffer.

pub fn channel(&self) -> Result<Channel<'_>>

Returns a corresponding channel attached to the HTTP message.

pub fn eom(&self) -> Result<bool>

Returns true if the end of message is reached.

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

Removes all HTTP header fields in the HTTP message whose name is specified in name.

pub fn get_headers(&self) -> Result<Headers<'_>>

Returns a table containing all the headers of the HTTP message.

pub fn get_stline(&self) -> Result<Table<'_>>

Returns a table containing the start-line of the HTTP message.

pub fn forward(&self, length: usize) -> Result<usize>

Forwards length bytes of data from the HTTP message. Returns the amount of data forwarded.

Because it is called in the filter context, it never yield. Only available incoming data may be forwarded, event if the requested length exceeds the available amount of incoming data.

pub fn input(&self) -> Result<usize>

Returns the length of incoming data in the HTTP message from the calling filter point of view.

pub fn insert(
    &self,
    data: impl AsRef<[u8]>,
    offset: Option<isize>
) -> Result<isize>

Copies the data at the offset in incoming data of the HTTP message. Returns the copied length on success or -1 if data cannot be copied.

By default, if no offset is provided, the string is copied in front of incoming data. A positive offset is relative to the beginning of incoming data of the channel buffer while negative offset is relative to their end.

pub fn is_full(&self) -> Result<bool>

Returns true if the HTTP message is full.

pub fn is_resp(&self) -> Result<bool>

Returns true if the HTTP message is the response one.

pub fn may_recv(&self) -> Result<bool>

Returns true if the HTTP message may still receive data.

pub fn output(&self) -> Result<usize>

Returns the length of outgoing data of the HTTP message.

pub fn prepend(&self, data: impl AsRef<[u8]>) -> Result<isize>

Copies the data in front of incoming data of the HTTP message. Returns the copied length on success or -1 if data cannot be copied.

pub fn remove(
    &self,
    offset: Option<isize>,
    length: Option<usize>
) -> Result<isize>

Removes length bytes of incoming data of the HTTP message, starting at offset. Returns number of bytes removed on success.

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

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

The replacement value can contain back references like 1, 2, … This function acts on whole header lines, regardless of the number of values they may contain.

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

Matches the regular expression on every comma-delimited value of header field name according to regex, and replaces them with the replace.

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

pub fn send(&self, data: impl AsRef<[u8]>) -> Result<isize>

Requires immediate send of the data. It means the data is copied at the beginning of incoming data of the HTTP message and immediately forwarded.

Because it is called in the filter context, it never yield.

pub fn set(
    &self,
    data: impl AsRef<[u8]>,
    offset: Option<isize>,
    length: Option<usize>
) -> Result<isize>

Replaces length bytes of incoming data of the HTTP message, starting at offset, by the string data. Returns the copied length on success or -1 if data cannot be copied.

pub fn set_eom(&self, eom: bool) -> Result<()>

Sets or removes the flag that indicates end of message.

pub fn set_header(&self, name: &str, value: impl AsRef<[u8]>) -> Result<()>

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

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

Rewrites the request method.

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

Rewrites the request path.

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

Rewrites the request’s query string which appears after the first question mark “?”.

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

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

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

Rewrites the request URI.

Trait Implementations

impl<'lua> Clone for HttpMessage<'lua>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'lua> FromLua<'lua> for HttpMessage<'lua>

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

Performs the conversion.