Skip to content

A data type for dealing with memory sizes

License

Notifications You must be signed in to change notification settings

flying7eleven/memory-size-type

Repository files navigation

MemorySize Type

Build MIT License API docs crates.io

This crate provides the MemorySize data type as a size unit. This might help errors during conversion between different units as well as comfort for printing the managed size as a human-readable value.

Usage

To use this library, you just have to add the following lines into your projects Cargo.toml:

[dependencies.memory-size-type]
version = "0.5.0"
default-features = false
features = ["std"]

Features

The crate is seperated into several features to reduce its size (even with this small crate). You can use the following features to enable the stuff you really need in your project:

Feature Description
std Include features like implementations for std::fmt::Debug and std::fmt::Display
deprecated Include the deprecated features like the MemorySize type.

Examples

There are different use-cases for this library. The following examples represent just some possible usages.

Creating an instance from raw byte information

use memory_size_type::Byte;

let size_info_byte = Byte::from(1024);

Calculating with memory sizes

use memory_size_type::Byte;

let some_bytes = Byte::from(1024);
let some_more_bytes = Byte::from(1024);

assert_eq!(some_bytes + some_more_bytes, 2048);

About

A data type for dealing with memory sizes

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages