mysql_common::io

Struct ParseBuf

pub struct ParseBuf<'a>(pub &'a [u8]);

Tuple Fields§

§0: &'a [u8]

Implementations§

impl<'a> ParseBuf<'a>

pub fn parse_unchecked<T>(&mut self, ctx: T::Ctx) -> Result<T>
where T: MyDeserialize<'a>,

Returns T: MyDeserialize deserialized from self.

Note, that this may panic if T::SIZE.is_some() and less than self.0.len().

pub fn parse<T>(&mut self, ctx: T::Ctx) -> Result<T>
where T: MyDeserialize<'a>,

Checked parse.

pub fn is_empty(&self) -> bool

Returns true if buffer is empty.

pub fn len(&self) -> usize

Returns the number of bytes in the buffer.

pub fn skip(&mut self, cnt: usize)

Skips the given number of bytes.

Afterwards self contains elements [cnt, len).

pub fn checked_skip(&mut self, cnt: usize) -> bool

Same as skip but returns false if buffer is too small.

pub fn eat(&mut self, n: usize) -> &'a [u8] ⓘ

Splits the buffer into two at the given index. Returns elements [0, n).

Afterwards self contains elements [n, len).

§Panic

Will panic if n > self.len().

pub fn eat_buf(&mut self, n: usize) -> Self

pub fn checked_eat(&mut self, n: usize) -> Option<&'a [u8]>

Same as eat. Returns None if buffer is too small.

pub fn checked_eat_buf(&mut self, n: usize) -> Option<Self>

pub fn eat_all(&mut self) -> &'a [u8] ⓘ

pub fn eat_u8(&mut self) -> u8

Consumes a number from the head of the buffer.

pub fn checked_eat_u8(&mut self) -> Option<u8>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_i8(&mut self) -> i8

Consumes a number from the head of the buffer.

pub fn checked_eat_i8(&mut self) -> Option<i8>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_u16_le(&mut self) -> u16

Consumes a number from the head of the buffer.

pub fn checked_eat_u16_le(&mut self) -> Option<u16>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_i16_le(&mut self) -> i16

Consumes a number from the head of the buffer.

pub fn checked_eat_i16_le(&mut self) -> Option<i16>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_u16_be(&mut self) -> u16

Consumes a number from the head of the buffer.

pub fn checked_eat_u16_be(&mut self) -> Option<u16>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_i16_be(&mut self) -> i16

Consumes a number from the head of the buffer.

pub fn checked_eat_i16_be(&mut self) -> Option<i16>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_u24_le(&mut self) -> u32

Consumes a number from the head of the buffer.

pub fn checked_eat_u24_le(&mut self) -> Option<u32>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_i24_le(&mut self) -> i32

Consumes a number from the head of the buffer.

pub fn checked_eat_i24_le(&mut self) -> Option<i32>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_u24_be(&mut self) -> u32

Consumes a number from the head of the buffer.

pub fn checked_eat_u24_be(&mut self) -> Option<u32>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_i24_be(&mut self) -> i32

Consumes a number from the head of the buffer.

pub fn checked_eat_i24_be(&mut self) -> Option<i32>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_u32_le(&mut self) -> u32

Consumes a number from the head of the buffer.

pub fn checked_eat_u32_le(&mut self) -> Option<u32>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_i32_le(&mut self) -> i32

Consumes a number from the head of the buffer.

pub fn checked_eat_i32_le(&mut self) -> Option<i32>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_u32_be(&mut self) -> u32

Consumes a number from the head of the buffer.

pub fn checked_eat_u32_be(&mut self) -> Option<u32>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_i32_be(&mut self) -> i32

Consumes a number from the head of the buffer.

pub fn checked_eat_i32_be(&mut self) -> Option<i32>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_u40_le(&mut self) -> u64

Consumes a number from the head of the buffer.

pub fn checked_eat_u40_le(&mut self) -> Option<u64>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_i40_le(&mut self) -> i64

Consumes a number from the head of the buffer.

pub fn checked_eat_i40_le(&mut self) -> Option<i64>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_u40_be(&mut self) -> u64

Consumes a number from the head of the buffer.

pub fn checked_eat_u40_be(&mut self) -> Option<u64>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_i40_be(&mut self) -> i64

Consumes a number from the head of the buffer.

pub fn checked_eat_i40_be(&mut self) -> Option<i64>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_u48_le(&mut self) -> u64

Consumes a number from the head of the buffer.

pub fn checked_eat_u48_le(&mut self) -> Option<u64>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_i48_le(&mut self) -> i64

Consumes a number from the head of the buffer.

pub fn checked_eat_i48_le(&mut self) -> Option<i64>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_u48_be(&mut self) -> u64

Consumes a number from the head of the buffer.

pub fn checked_eat_u48_be(&mut self) -> Option<u64>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_i48_be(&mut self) -> i64

Consumes a number from the head of the buffer.

pub fn checked_eat_i48_be(&mut self) -> Option<i64>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_u56_le(&mut self) -> u64

Consumes a number from the head of the buffer.

pub fn checked_eat_u56_le(&mut self) -> Option<u64>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_i56_le(&mut self) -> i64

Consumes a number from the head of the buffer.

pub fn checked_eat_i56_le(&mut self) -> Option<i64>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_u56_be(&mut self) -> u64

Consumes a number from the head of the buffer.

pub fn checked_eat_u56_be(&mut self) -> Option<u64>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_i56_be(&mut self) -> i64

Consumes a number from the head of the buffer.

pub fn checked_eat_i56_be(&mut self) -> Option<i64>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_u64_le(&mut self) -> u64

Consumes a number from the head of the buffer.

pub fn checked_eat_u64_le(&mut self) -> Option<u64>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_i64_le(&mut self) -> i64

Consumes a number from the head of the buffer.

pub fn checked_eat_i64_le(&mut self) -> Option<i64>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_u64_be(&mut self) -> u64

Consumes a number from the head of the buffer.

pub fn checked_eat_u64_be(&mut self) -> Option<u64>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_i64_be(&mut self) -> i64

Consumes a number from the head of the buffer.

pub fn checked_eat_i64_be(&mut self) -> Option<i64>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_u128_le(&mut self) -> u128

Consumes a number from the head of the buffer.

pub fn checked_eat_u128_le(&mut self) -> Option<u128>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_i128_le(&mut self) -> i128

Consumes a number from the head of the buffer.

pub fn checked_eat_i128_le(&mut self) -> Option<i128>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_u128_be(&mut self) -> u128

Consumes a number from the head of the buffer.

pub fn checked_eat_u128_be(&mut self) -> Option<u128>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_i128_be(&mut self) -> i128

Consumes a number from the head of the buffer.

pub fn checked_eat_i128_be(&mut self) -> Option<i128>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_f32_le(&mut self) -> f32

Consumes a number from the head of the buffer.

pub fn checked_eat_f32_le(&mut self) -> Option<f32>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_f32_be(&mut self) -> f32

Consumes a number from the head of the buffer.

pub fn checked_eat_f32_be(&mut self) -> Option<f32>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_f64_le(&mut self) -> f64

Consumes a number from the head of the buffer.

pub fn checked_eat_f64_le(&mut self) -> Option<f64>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_f64_be(&mut self) -> f64

Consumes a number from the head of the buffer.

pub fn checked_eat_f64_be(&mut self) -> Option<f64>

Consumes a number from the head of the buffer. Returns None if buffer is too small.

pub fn eat_lenenc_int(&mut self) -> u64

Consumes MySql length-encoded integer from the head of the buffer.

Returns 0 if integer is maliformed (starts with 0xff or 0xfb). First byte will be eaten.

pub fn checked_eat_lenenc_int(&mut self) -> Option<u64>

Same as eat_lenenc_int. Returns None if buffer is too small.

pub fn eat_lenenc_str(&mut self) -> &'a [u8] ⓘ

Consumes MySql length-encoded string from the head of the buffer.

Returns an empty slice if length is maliformed (starts with 0xff). First byte will be eaten.

pub fn checked_eat_lenenc_str(&mut self) -> Option<&'a [u8]>

Same as eat_lenenc_str. Returns None if buffer is too small.

pub fn eat_u8_str(&mut self) -> &'a [u8] ⓘ

Consumes MySql string with u8 length prefix from the head of the buffer.

pub fn checked_eat_u8_str(&mut self) -> Option<&'a [u8]>

Same as eat_u8_str. Returns None if buffer is too small.

pub fn eat_u32_str(&mut self) -> &'a [u8] ⓘ

Consumes MySql string with u32 length prefix from the head of the buffer.

pub fn checked_eat_u32_str(&mut self) -> Option<&'a [u8]>

Same as eat_u32_str. Returns None if buffer is too small.

pub fn eat_null_str(&mut self) -> &'a [u8] ⓘ

Consumes null-terminated string from the head of the buffer.

Consumes whole buffer if there is no 0-byte.

Trait Implementations§

impl<'a> Clone for ParseBuf<'a>

fn clone(&self) -> ParseBuf<'a> ⓘ

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<'a> Debug for ParseBuf<'a>

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

Formats the value using the given formatter. Read more

impl<'de> MyDeserialize<'de> for ParseBuf<'de>

const SIZE: Option<usize> = None

Size hint of a serialized value (in bytes), if it’s constant.

type Ctx = usize

Some structs defines deserialization in the context of another value. Read more

fn deserialize(len: Self::Ctx, buf: &mut ParseBuf<'de>) -> Result<Self>

Deserializes self from the given buf. Read more

impl<'a> PartialEq for ParseBuf<'a>

fn eq(&self, other: &ParseBuf<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Read for ParseBuf<'_>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more

1.36.0 · Source§

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers. Read more

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation. Read more

1.0.0 · Source§

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf. Read more

1.0.0 · Source§

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf. Read more

1.6.0 · Source§

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf. Read more

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer. Read more

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor. Read more

1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adaptor for this instance of Read. Read more

1.0.0 · Source§

fn bytes(self) -> Bytes<Self>
where Self: Sized,

Transforms this Read instance to an Iterator over its bytes. Read more

1.0.0 · Source§

fn chain<R>(self, next: R) -> Chain<Self, R>
where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another. Read more

1.0.0 · Source§

fn take(self, limit: u64) -> Take<Self>
where Self: Sized,

Creates an adapter which will read at most limit bytes from it. Read more

impl<'a> Copy for ParseBuf<'a>

impl<'a> Eq for ParseBuf<'a>

impl<'a> StructuralPartialEq for ParseBuf<'a>

Auto Trait Implementations§

impl<'a> Freeze for ParseBuf<'a>

impl<'a> RefUnwindSafe for ParseBuf<'a>

impl<'a> Send for ParseBuf<'a>

impl<'a> Sync for ParseBuf<'a>

impl<'a> Unpin for ParseBuf<'a>

impl<'a> UnwindSafe for ParseBuf<'a>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<R> ReadBytesExt for R
where R: Read + ?Sized,

fn read_u8(&mut self) -> Result<u8, Error>

Reads an unsigned 8 bit integer from the underlying reader. Read more

fn read_i8(&mut self) -> Result<i8, Error>

Reads a signed 8 bit integer from the underlying reader. Read more

fn read_u16<T>(&mut self) -> Result<u16, Error>
where T: ByteOrder,

Reads an unsigned 16 bit integer from the underlying reader. Read more

fn read_i16<T>(&mut self) -> Result<i16, Error>
where T: ByteOrder,

Reads a signed 16 bit integer from the underlying reader. Read more

fn read_u24<T>(&mut self) -> Result<u32, Error>
where T: ByteOrder,

Reads an unsigned 24 bit integer from the underlying reader. Read more

fn read_i24<T>(&mut self) -> Result<i32, Error>
where T: ByteOrder,

Reads a signed 24 bit integer from the underlying reader. Read more

fn read_u32<T>(&mut self) -> Result<u32, Error>
where T: ByteOrder,

Reads an unsigned 32 bit integer from the underlying reader. Read more

fn read_i32<T>(&mut self) -> Result<i32, Error>
where T: ByteOrder,

Reads a signed 32 bit integer from the underlying reader. Read more

fn read_u48<T>(&mut self) -> Result<u64, Error>
where T: ByteOrder,

Reads an unsigned 48 bit integer from the underlying reader. Read more

fn read_i48<T>(&mut self) -> Result<i64, Error>
where T: ByteOrder,

Reads a signed 48 bit integer from the underlying reader. Read more

fn read_u64<T>(&mut self) -> Result<u64, Error>
where T: ByteOrder,

Reads an unsigned 64 bit integer from the underlying reader. Read more

fn read_i64<T>(&mut self) -> Result<i64, Error>
where T: ByteOrder,

Reads a signed 64 bit integer from the underlying reader. Read more

fn read_u128<T>(&mut self) -> Result<u128, Error>
where T: ByteOrder,

Reads an unsigned 128 bit integer from the underlying reader. Read more

fn read_i128<T>(&mut self) -> Result<i128, Error>
where T: ByteOrder,

Reads a signed 128 bit integer from the underlying reader. Read more

fn read_uint<T>(&mut self, nbytes: usize) -> Result<u64, Error>
where T: ByteOrder,

Reads an unsigned n-bytes integer from the underlying reader. Read more

fn read_int<T>(&mut self, nbytes: usize) -> Result<i64, Error>
where T: ByteOrder,

Reads a signed n-bytes integer from the underlying reader. Read more

fn read_uint128<T>(&mut self, nbytes: usize) -> Result<u128, Error>
where T: ByteOrder,

Reads an unsigned n-bytes integer from the underlying reader.

fn read_int128<T>(&mut self, nbytes: usize) -> Result<i128, Error>
where T: ByteOrder,

Reads a signed n-bytes integer from the underlying reader.

fn read_f32<T>(&mut self) -> Result<f32, Error>
where T: ByteOrder,

Reads a IEEE754 single-precision (4 bytes) floating point number from the underlying reader. Read more

fn read_f64<T>(&mut self) -> Result<f64, Error>
where T: ByteOrder,

Reads a IEEE754 double-precision (8 bytes) floating point number from the underlying reader. Read more

fn read_u16_into<T>(&mut self, dst: &mut [u16]) -> Result<(), Error>
where T: ByteOrder,

Reads a sequence of unsigned 16 bit integers from the underlying reader. Read more

fn read_u32_into<T>(&mut self, dst: &mut [u32]) -> Result<(), Error>
where T: ByteOrder,

Reads a sequence of unsigned 32 bit integers from the underlying reader. Read more

fn read_u64_into<T>(&mut self, dst: &mut [u64]) -> Result<(), Error>
where T: ByteOrder,

Reads a sequence of unsigned 64 bit integers from the underlying reader. Read more

fn read_u128_into<T>(&mut self, dst: &mut [u128]) -> Result<(), Error>
where T: ByteOrder,

Reads a sequence of unsigned 128 bit integers from the underlying reader. Read more

fn read_i8_into(&mut self, dst: &mut [i8]) -> Result<(), Error>

Reads a sequence of signed 8 bit integers from the underlying reader. Read more

fn read_i16_into<T>(&mut self, dst: &mut [i16]) -> Result<(), Error>
where T: ByteOrder,

Reads a sequence of signed 16 bit integers from the underlying reader. Read more

fn read_i32_into<T>(&mut self, dst: &mut [i32]) -> Result<(), Error>
where T: ByteOrder,

Reads a sequence of signed 32 bit integers from the underlying reader. Read more

fn read_i64_into<T>(&mut self, dst: &mut [i64]) -> Result<(), Error>
where T: ByteOrder,

Reads a sequence of signed 64 bit integers from the underlying reader. Read more

fn read_i128_into<T>(&mut self, dst: &mut [i128]) -> Result<(), Error>
where T: ByteOrder,

Reads a sequence of signed 128 bit integers from the underlying reader. Read more

fn read_f32_into<T>(&mut self, dst: &mut [f32]) -> Result<(), Error>
where T: ByteOrder,

Reads a sequence of IEEE754 single-precision (4 bytes) floating point numbers from the underlying reader. Read more

fn read_f32_into_unchecked<T>(&mut self, dst: &mut [f32]) -> Result<(), Error>
where T: ByteOrder,

👎Deprecated since 1.2.0: please use read_f32_into instead

DEPRECATED. Read more

fn read_f64_into<T>(&mut self, dst: &mut [f64]) -> Result<(), Error>
where T: ByteOrder,

Reads a sequence of IEEE754 double-precision (8 bytes) floating point numbers from the underlying reader. Read more

fn read_f64_into_unchecked<T>(&mut self, dst: &mut [f64]) -> Result<(), Error>
where T: ByteOrder,

👎Deprecated since 1.2.0: please use read_f64_into instead

DEPRECATED. Read more

impl<T> ReadMysqlExt for T
where T: ReadBytesExt,

fn read_lenenc_int(&mut self) -> Result<u64>

Reads MySql’s length-encoded integer.

fn read_lenenc_str(&mut self) -> Result<Vec<u8>>

Reads MySql’s length-encoded string.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.