2 releases
0.1.1 | Sep 2, 2024 |
---|---|
0.1.0 | Sep 2, 2024 |
#448 in Text processing
72 downloads per month
42KB
826 lines
A Rust implementation of Twilio's Message Segment Calculator, originally written in JavaScript.
Overview
This library provides functionality to segment SMS messages, detect their character set, encoding, and other properties. It's particularly useful for applications that need to work with SMS messages at a low level, ensuring proper encoding and segmentation for delivery.
Features
- Segment SMS messages
- Detect character encoding (GSM-7 or UCS-2)
- Smart character encoding
- Handle User Data Headers
- Calculate message size and segment count
Installation
Add the following to your Cargo.toml
:
[dependencies]
message_segment_calculator = "0.1.0"
Usage
Here's a basic example of how to use the library:
use message_segment_calculator::{SegmentedMessage, Encoding};
fn main() {
let message = "Hello, world! 👋";
let encoding = Encoding::Auto;
let smart_encoding = true;
match SegmentedMessage::new(message, encoding, smart_encoding) {
Ok(segmented_message) => {
println!("Encoding: {:?}", segmented_message.get_encoding_name());
println!("Number of segments: {}", segmented_message.segments_count());
println!("Total size in bits: {}", segmented_message.total_size());
}
Err(e) => println!("Error: {}", e),
}
}
API
The main struct is SegmentedMessage
. Here are some of its key methods:
-
Initializes struct with a given messagenew(message: &str, encoding: Encoding, smart_encoding: bool) -> Result<SegmentedMessage, String>
-
Returns the detected encodingget_encoding_name() -> Encoding
-
Returns the total message size in bitstotal_size() -> u16
-
Returns the message size in bits (minus UDH)message_size() -> u16
-
Returns count of segmentssegments_count() -> usize
-
Returns vector of all UCS2 characters detected in the messageget_non_gsm_characters() -> HashSet<String>
The other structs are exposed and can be used for their specific operations.
A simple CLI tool is included and can be accessed with cargo run -- "Message
. It will print out the statistics for a
given string.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the MIT License - see the LICENSE.md file for details.
Dependencies
~1MB
~33K SLoC