iceoryx2-bb-elementary 0.8.1

iceoryx2: [internal] elementary constructs that have (almost) no dependencies at all
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

// Copyright (c) 2023 - 2024 Contributors to the Eclipse Foundation
//
// See the NOTICE file(s) distributed with this work for additional
// information regarding copyright ownership.
//
// This program and the accompanying materials are made available under the
// terms of the Apache Software License 2.0 which is available at
// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
// which is available at https://opensource.org/licenses/MIT.
//
// SPDX-License-Identifier: Apache-2.0 OR MIT

//! Contains simplistic math functions.

use alloc::string::String;

/// Returns the required memory size when alignment adjustments are taken into account
pub const fn unaligned_mem_size<T>(array_capacity: usize) -> usize {
    core::mem::size_of::<T>() * array_capacity + core::mem::align_of::<T>() - 1
}

/// Aligns value to alignment. It increments value to the next multiple of alignment.
pub const fn align(value: usize, alignment: usize) -> usize {
    if value % alignment == 0 {
        value
    } else {
        value + alignment - value % alignment
    }
}

/// Aligns value to the alignment of T.
pub const fn align_to<T>(value: usize) -> usize {
    align(value, core::mem::align_of::<T>())
}

pub trait ToB64 {
    fn to_b64(&self) -> String;
}

impl ToB64 for u128 {
    fn to_b64(&self) -> String {
        let mut quotient = *self;
        let mut remainder;
        let mut ret_val = String::new();

        let remainder_to_char = |value| -> char {
            if value < 10 {
                ((48 + value) as u8) as char
            } else if value < 26 + 10 {
                ((65 + value - 10) as u8) as char
            } else if value < 62 {
                ((97 + value - 10 - 26) as u8) as char
            } else if value == 62 {
                45 as char
            } else {
                95 as char
            }
        };

        loop {
            remainder = quotient % 64;
            quotient /= 64;

            ret_val.push(remainder_to_char(remainder));

            if quotient == 0 {
                break;
            }
        }

        ret_val
    }
}

impl ToB64 for u64 {
    fn to_b64(&self) -> String {
        (*self as u128).to_b64()
    }
}

impl ToB64 for u32 {
    fn to_b64(&self) -> String {
        (*self as u128).to_b64()
    }
}

impl ToB64 for u16 {
    fn to_b64(&self) -> String {
        (*self as u128).to_b64()
    }
}

impl ToB64 for u8 {
    fn to_b64(&self) -> String {
        (*self as u128).to_b64()
    }
}

impl<const N: usize> ToB64 for [u8; N] {
    fn to_b64(&self) -> String {
        let mut result = String::new();
        let mut i = 0;
        while N != i {
            if 16 < N - i {
                let mut data = [0u8; 16];
                data.copy_from_slice(&self[i..i + 16]);
                result.push_str(&u128::from_le_bytes(data).to_b64());
                i += 16;
            } else if 8 < N - i {
                let mut data = [0u8; 8];
                data.copy_from_slice(&self[i..i + 8]);
                result.push_str(&u64::from_le_bytes(data).to_b64());
                i += 8;
            } else if 4 < N - i {
                let mut data = [0u8; 4];
                data.copy_from_slice(&self[i..i + 4]);
                i += 8;
                result.push_str(&u32::from_le_bytes(data).to_b64());
                i += 4;
            } else if 2 < N - i {
                let mut data = [0u8; 2];
                data.copy_from_slice(&self[i..i + 2]);
                result.push_str(&u16::from_le_bytes(data).to_b64());
                i += 2;
            } else {
                result.push_str(&self[i].to_b64());
                i += 1;
            }
        }
        result
    }
}

/// Returns the larger of the two provided numbers
///
/// # Example
///
/// ```
/// use iceoryx2_bb_elementary::math::max;
///
/// const SIZE: usize = max(core::mem::size_of::<u32>(), core::mem::size_of::<u32>());
/// ```
///
/// # Note
///
/// Once const traits are stable, this should become a generic implementation for `T: PartialOrd`
pub const fn max(a: usize, b: usize) -> usize {
    if a > b {
        a
    } else {
        b
    }
}