Struct haproxy_api::Channel

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

The “Channel” class contains all functions to manipulate channels.

Please refer to HAProxy documentation to get more information.

Implementations

impl<'lua> Channel<'lua>

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

Copies the string string at the end of incoming data of the channel buffer. Returns the copied length on success or -1 if data cannot be copied.

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

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

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

Forwards length bytes of data from the channel buffer. Returns the amount of data forwarded and must not be called from an action to avoid yielding.

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

Returns the length of incoming data in the channel buffer.

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

Copies the data at the offset in incoming data of the channel buffer. 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 channel buffer is full.

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

Returns true if the channel is the response one.

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

Parses length bytes of incoming data of the channel buffer, starting at offset, and returns the first line found, including the \n.

The data are not removed from the buffer. If no line is found, all data are returned.

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

Returns true if the channel may still receive data.

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

Returns the length of outgoing data of the channel buffer.

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

Copies the data in front of incoming data of the channel buffer. 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 channel buffer, starting at offset. Returns number of bytes removed on success.

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 channel buffer and immediately forwarded.

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

Replaces length bytes of incoming data of the channel buffer, starting at offset, by the new data. Returns the copied length on success or -1 if data cannot be copied.

Trait Implementations

impl<'lua> Clone for Channel<'lua>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'lua> FromLua<'lua> for Channel<'lua>

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

Performs the conversion.

impl<'lua> IntoLua<'lua> for Channel<'lua>

fn into_lua(self, _: &'lua Lua) -> Result<Value<'lua>>

Performs the conversion.