pub struct Encoding(pub InternalEncoding);
Expand description

Base-conversion encoding

See Specification for technical details or how to define a new one.

Tuple Fields

0: InternalEncoding

Implementations

Returns the encoded length of an input of length len

See encode_mut for when to use it.

Encodes input in output

Panics

Panics if the output length does not match the result of encode_len for the input length.

Examples
use data_encoding::BASE64;
let input = b"Hello world";
let output = &mut buffer[0 .. BASE64.encode_len(input.len())];
BASE64.encode_mut(input, output);
assert_eq!(output, b"SGVsbG8gd29ybGQ=");

Appends the encoding of input to output

Examples
use data_encoding::BASE64;
let input = b"Hello world";
let mut output = "Result: ".to_string();
BASE64.encode_append(input, &mut output);
assert_eq!(output, "Result: SGVsbG8gd29ybGQ=");
Features

Requires the alloc feature.

Returns encoded input

Examples
use data_encoding::BASE64;
assert_eq!(BASE64.encode(b"Hello world"), "SGVsbG8gd29ybGQ=");
Features

Requires the alloc feature.

Returns the decoded length of an input of length len

See decode_mut for when to use it.

Errors

Returns an error if len is invalid. The error kind is Length and the position is the greatest valid input length.

Decodes input in output

Returns the length of the decoded output. This length may be smaller than the output length if the input contained padding or ignored characters. The output bytes after the returned length are not initialized and should not be read.

Panics

Panics if the output length does not match the result of decode_len for the input length. Also panics if decode_len fails for the input length.

Errors

Returns an error if input is invalid. See decode for more details. The are two differences though:

  • Length may be returned only if the encoding allows ignored characters, because otherwise this is already checked by decode_len.
  • The read first bytes of the input have been successfully decoded to the written first bytes of the output.
Examples
use data_encoding::BASE64;
let input = b"SGVsbA==byB3b3JsZA==";
let output = &mut buffer[0 .. BASE64.decode_len(input.len()).unwrap()];
let len = BASE64.decode_mut(input, output).unwrap();
assert_eq!(&output[0 .. len], b"Hello world");

Returns decoded input

Errors

Returns an error if input is invalid. The error kind can be:

  • Length if the input length is invalid. The position is the greatest valid input length.
  • Symbol if the input contains an invalid character. The position is the first invalid character.
  • Trailing if the input has non-zero trailing bits. This is only possible if the encoding checks trailing bits. The position is the first character containing non-zero trailing bits.
  • Padding if the input has an invalid padding length. This is only possible if the encoding uses padding. The position is the first padding character of the first padding of invalid length.
Examples
use data_encoding::BASE64;
assert_eq!(BASE64.decode(b"SGVsbA==byB3b3JsZA==").unwrap(), b"Hello world");
Features

Requires the alloc feature.

Returns the bit-width

Returns whether the encoding is canonical

An encoding is not canonical if one of the following conditions holds:

  • trailing bits are not checked
  • padding is used
  • characters are ignored
  • characters are translated

Returns the encoding specification

Features

Requires the alloc feature.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

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

The resulting type after obtaining ownership.

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

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

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

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.