Struct Ucs2 

pub struct Ucs2 { /* private fields */ }

Available on crate feature encoding only.

UCS2 codec.

Implementations

impl Ucs2

pub fn encode_to_vec(&self, input: &str) -> Result<Vec<u8>, Ucs2EncodeError>

Available on crate feature alloc only.

Encodes the given message into a vector of bytes.

impl Ucs2

pub const fn new() -> Self

Creates a new Ucs2 codec.

Defaults

• allow_split_character: false

Examples found in repository

examples/submit_sm_multipart_fallback.rs (line 31)

fn main() -> Result<(), Box<dyn core::error::Error>> {
    let multipart = SubmitSm::builder()
        .source_addr_ton(Ton::Unknown)
        .source_addr_npi(Npi::Unknown)
        .source_addr(COctetString::from_str("12345")?)
        .destination_addr(COctetString::from_str("491701234567")?)
        .build()
        .multipart("Hi This message can not be encoded in gsm 7-bit default alphabet so it will fallback to ucs2: 你好")
        .encoder(Gsm7BitUnpacked::new().with_alphabet(Gsm7BitAlphabet::default()))
        .fallback(Ucs2::new())
        .build()?;

    let total = multipart.len();

    println!("Submitting multipart message: total {total}");

    for (i, sm) in multipart.into_iter().enumerate() {
        assert_eq!(sm.data_coding, Ucs2::new().data_coding());

        println!(
            "Submitting part {}: short_message_len = {}, esm_class = {:?}, data_coding = {:?}, short_message = {:?}",
            i + 1,
            sm.short_message().len(),
            sm.esm_class,
            sm.data_coding,
            sm.short_message()
        );
        println!()
    }

    Ok(())
}

examples/submit_sm_encode.rs (line 37)

fn main() -> Result<(), Box<dyn core::error::Error>> {
    // c-spell: disable
    let message = r##"Hello world!

@£$¥èéùìòÇØøÅåΔ_ΦΓΛΩΠΨΣΘΞÆæßÉ !"#¤%&'()*+,-./0123456789:;<=>?¡ABCDEFGHIJKLMNOPQRSTUVWXYZÄÖÑܧ¿abcdefghijklmnopqrstuvwxyzäöñüà

^{}\[~]|€"##;
    // c-spell: enable

    let sm = SubmitSm::builder()
        .source_addr_ton(Ton::Unknown)
        .source_addr_npi(Npi::Unknown)
        .source_addr(COctetString::from_str("12345")?)
        .destination_addr(COctetString::from_str("491701234567")?)
        // data_coding will be overridden by the encoding builder to match the encoder.
        .data_coding(DataCoding::default())
        // short_message will be overridden by `short_message` of the encoding builder.
        .short_message(OctetString::from_str("Hi, I am a short message.")?)
        .build()
        .encode(message)
        .gsm7bit_unpacked()
        .fallback(Ucs2::new())
        .build()?;

    println!(
        "Encoded: short_message_len = {}, data_coding = {:?}, short_message = {:?}",
        sm.short_message().len(),
        sm.data_coding,
        sm.short_message()
    );

    Ok(())
}

pub const fn allow_split_character(&self) -> bool

Returns whether splitting characters is allowed.

pub const fn with_allow_split_character(self, allow: bool) -> Self

Sets whether to allow splitting characters across message parts.

pub const fn data_coding(&self) -> DataCoding

Returns the associated DataCoding.

Examples found in repository

examples/submit_sm_multipart_fallback.rs (line 39)

fn main() -> Result<(), Box<dyn core::error::Error>> {
    let multipart = SubmitSm::builder()
        .source_addr_ton(Ton::Unknown)
        .source_addr_npi(Npi::Unknown)
        .source_addr(COctetString::from_str("12345")?)
        .destination_addr(COctetString::from_str("491701234567")?)
        .build()
        .multipart("Hi This message can not be encoded in gsm 7-bit default alphabet so it will fallback to ucs2: 你好")
        .encoder(Gsm7BitUnpacked::new().with_alphabet(Gsm7BitAlphabet::default()))
        .fallback(Ucs2::new())
        .build()?;

    let total = multipart.len();

    println!("Submitting multipart message: total {total}");

    for (i, sm) in multipart.into_iter().enumerate() {
        assert_eq!(sm.data_coding, Ucs2::new().data_coding());

        println!(
            "Submitting part {}: short_message_len = {}, esm_class = {:?}, data_coding = {:?}, short_message = {:?}",
            i + 1,
            sm.short_message().len(),
            sm.esm_class,
            sm.data_coding,
            sm.short_message()
        );
        println!()
    }

    Ok(())
}

Trait Implementations

impl Concatenator for Ucs2

Available on crate feature alloc only.

type Error = Ucs2ConcatenateError

Available on crate feature concatenation only.

The type of errors that can occur during concatenation.

fn concatenate( &self, message: &str, max_message_size: usize, part_header_size: usize, ) -> Result<(Concatenation, DataCoding), Self::Error>

Available on crate feature concatenation only.

Splits the encoded message into concatenated parts and their associated DataCoding.

impl Debug for Ucs2

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

Formats the value using the given formatter.

impl Default for Ucs2

fn default() -> Self

Returns the “default value” for a type.

impl Encoder for Ucs2

Available on crate feature alloc only.

type Error = Ucs2EncodeError

The type of errors that can occur during encoding.

fn encode(&self, message: &str) -> Result<(Vec<u8>, DataCoding), Self::Error>

Encodes the given message into a vector of bytes and its associated DataCoding.