Skip to main content

Encoder

Struct Encoder 

Source
pub struct Encoder { /* private fields */ }
Expand description

Writes CDR into a growable buffer.

Alignment is relative to the stream offset of the first byte, which is 0 unless the encoder was created with Encoder::with_offset.

An encoder that allows shared octets keeps large octet sequences written with write_octet_seq_shared apart from its buffer: into_parts gives the buffer and where each goes, for a vectored write, and into_bytes puts them in place.

Implementations§

Source§

impl Encoder

Source

pub fn new(order: ByteOrder, version: CdrVersion) -> Encoder

Creates an encoder whose first byte is at stream offset 0.

Source

pub fn with_offset( order: ByteOrder, version: CdrVersion, base: usize, ) -> Encoder

Creates an encoder whose first byte is at stream offset base.

Source

pub fn encapsulation(order: ByteOrder, version: CdrVersion) -> Encoder

Starts an encapsulation: offset 0, with the byte order octet written.

Source

pub fn set_wstring_bom(&mut self, bom: bool)

Chooses how a GIOP 1.2 wstring is written: with a BOM followed by code units in the stream byte order (the default, as omniORB does), or, when false, big endian without a BOM (the form the specification defines for a missing BOM). Readers that follow CORBA 2.4 or later accept both.

Source

pub fn byte_order(&self) -> ByteOrder

The byte order of the stream.

Source

pub fn version(&self) -> CdrVersion

The GIOP version whose CDR rules apply.

Source

pub fn position(&self) -> usize

The stream offset of the next byte.

Source

pub fn len(&self) -> usize

Bytes written so far, shared octets included.

Source

pub fn is_empty(&self) -> bool

Whether nothing has been written.

Source

pub fn as_bytes(&self) -> &[u8] ⓘ

The bytes written into the buffer so far: all of them, unless shared octets were kept apart.

Source

pub fn as_bytes_mut(&mut self) -> &mut [u8] ⓘ

Mutable access to the buffer, for patching lengths. Indexes are buffer indexes, which differ from stream offsets after shared octets.

Source

pub fn truncate(&mut self, len: usize)

Drops bytes past len, which must not be before shared octets.

Source

pub fn into_bytes(self) -> Vec<u8> ⓘ

Consumes the encoder and returns the bytes, shared octets copied in place.

Source

pub fn into_parts(self) -> (Vec<u8>, Vec<(usize, Octets)>)

Consumes the encoder and returns the buffer and the shared octets, each with the buffer length at which it goes.

Source

pub fn reserve(&mut self, additional: usize)

Makes room for at least additional more bytes in the buffer.

Source

pub fn allow_shared(&mut self, allow: bool)

Lets write_octet_seq_shared keep large octet sequences apart from the buffer. Only for an encoder whose result goes out through into_parts or into_bytes, not one read through as_bytes.

Source

pub fn align(&mut self, align: usize)

Pads with zero octets until the stream offset is a multiple of align.

Source

pub fn write_octet(&mut self, value: u8)

Writes an octet.

Source

pub fn write_bool(&mut self, value: bool)

Writes a boolean.

Source

pub fn write_char(&mut self, value: u8)

Writes a char as a single octet in the transmission code set.

Source

pub fn write_i16(&mut self, value: i16)

Writes a short.

Source

pub fn write_u16(&mut self, value: u16)

Writes an unsigned short.

Source

pub fn write_i32(&mut self, value: i32)

Writes a long.

Source

pub fn write_u32(&mut self, value: u32)

Writes an unsigned long.

Source

pub fn write_i64(&mut self, value: i64)

Writes a long long.

Source

pub fn write_u64(&mut self, value: u64)

Writes an unsigned long long.

Source

pub fn write_f32(&mut self, value: f32)

Writes a float.

Source

pub fn write_f64(&mut self, value: f64)

Writes a double.

Source

pub fn write_long_double(&mut self, value: LongDouble)

Writes a long double: 16 octets on an 8 octet boundary.

Source

pub fn write_octets(&mut self, bytes: &[u8])

Writes raw octets without alignment or a length.

Source

pub fn write_len(&mut self, len: usize) -> Result<()>

Writes a sequence length.

Source

pub fn write_octet_seq(&mut self, bytes: &[u8]) -> Result<()>

Writes a sequence<octet>.

Source

pub fn write_octet_seq_shared(&mut self, octets: &Octets) -> Result<()>

Writes a sequence<octet> without copying a large one, if the encoder allows it and no valuetype is being written (whose chunk lengths count the buffer). Otherwise like write_octet_seq.

Source

pub fn write_string_bytes(&mut self, bytes: &[u8]) -> Result<()>

Writes a string from bytes already in the transmission code set.

The length includes the terminating NUL, which is appended here.

Source

pub fn write_string(&mut self, value: &str) -> Result<()>

Writes a string as UTF-8.

Source

pub fn write_wchar(&mut self, value: u16) -> Result<()>

Writes a wchar holding one UTF-16 code unit.

GIOP 1.1 writes an aligned unsigned short in the stream byte order. GIOP 1.2 writes an octet length of 2 followed by the code unit in big endian without a BOM, as omniORB does.

Source

pub fn write_wstring(&mut self, value: &str) -> Result<()>

Writes a wstring encoded as UTF-16.

GIOP 1.1 writes the number of code units including a terminating NUL, then aligned code units in the stream byte order. GIOP 1.2 writes the octet length, then the code units without a terminator: by default a BOM followed by the stream byte order, or big endian without a BOM (see Encoder::set_wstring_bom). An empty string is just a zero length.

Source

pub fn write_encapsulation<F>(&mut self, f: F) -> Result<()>
where F: FnOnce(&mut Encoder) -> Result<()>,

Writes an encapsulation as a sequence<octet>.

f writes the contents into a fresh encoder whose alignment starts at the byte order octet. The encapsulation uses this stream’s byte order and version.

Source§

impl Encoder

Source

pub fn write_null_value(&mut self)

Writes a null value.

Source

pub fn begin_value( &mut self, key: u64, ids: &[&str], chunked: bool, ) -> Result<bool>

Starts writing a value.

key identifies the value: if a value with the same key was written before in this stream, an indirection to it is written and false is returned. Otherwise the value tag and ids (repository ids, most derived first; none leaves the type to the receiver) are written and true is returned: the caller writes the state and then calls Encoder::end_value.

A value nested in a chunked value is chunked as well.

Source

pub fn end_value(&mut self) -> Result<()>

Ends the value started by the last Encoder::begin_value that returned true.

Trait Implementations§

Source§

impl Clone for Encoder

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Encoder

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.