cbfr 0.1.6

A buffer that run on stack, focusing on performance and speed
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
use std::borrow::Borrow;
use std::borrow::BorrowMut;
use std::fmt::Display;
use std::ops::{Add, Sub, Mul, Div};
use std::mem;


use crate::helper as helper;
use crate::errors as err;

pub type NecResult = Result<(), err::NotEnoughCapacity>;
pub type IidxResult = Result<(), err::InvalidIndex>;

/// BFRDYN default capacity
/// # To create an instance with default capacity
/// ```
/// use cbfr::cb::BFRDYN;
///
/// let b1: BFRDYN = "another string".into();       // create a buffer with default capacity (256)
/// let mut b2: BFRDYN = BFRDYN::def();             // create a buffer with default capacity (256)
/// 
/// b2.append_str("also another string");
/// 
/// assert_eq!("another string", b1.to_string());
/// assert_eq!("also another string", b2.to_string());
/// ```
/// 
pub const DEFCAPACITY: usize = 256;


/// BFRDYN is a buffer data type focusing on performance and speed
/// It's primary usage is to manipulate short text data. Built on top of Rust array, 
/// BFRDYN store data on the stack, as a consequences it can only store small size data.
/// You can explicitly provide the size of the buffer, but if you ignore it, by default BFRDYN has capacity of 256 * 8bit
/// # example:
/// ```
/// use cbfr::cb::BFRDYN;
///
/// let b1 = BFRDYN::<125>::from("some string");    // create a buffer with capacity = 125
/// let b2: BFRDYN = "another string".into();       // create a buffer with default capacity (256)
/// let mut b3: BFRDYN = BFRDYN::def();       // create a buffer with default capacity (256)
/// 
/// b3.append_str("more string");
/// assert_eq!(b1.to_string(), "some string");
/// assert_eq!(b2.to_string(), "another string");
/// assert_eq!(b3.to_string(), "more string");
/// ```
#[derive(Debug, Hash)]
pub struct BFRDYN<const CAPACITY: usize = DEFCAPACITY> {
    arr: [u8; CAPACITY],
    len: usize
}

// Display Trait
impl<const CAPACITY: usize> Display for BFRDYN<CAPACITY> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { 
        helper::fmt(&self.len, &self.arr, f) 
    }
}

/// Create or Convert buffer instance from &Self<SIZEA> to Self<SIZEB>
/// # Example
/// ```
/// use cbfr::cb::BFRDYN;
///
/// let b256: BFRDYN<256> = "some string".into();
/// let b512: BFRDYN<512> = (&b256).into();
/// let b8: BFRDYN<8> = (&b256).into();
///
/// assert_eq!("some string", b512.as_str());
/// assert_eq!("some str", b8.as_str());
/// assert_eq!(8, b8.len());
/// assert_eq!(11, b512.len());
/// ```
///
impl<const S1: usize, const S2: usize> From<&BFRDYN<S1>> for BFRDYN<S2> {
    fn from(value: &BFRDYN<S1>) -> Self {
        let mut arr = [0u8; S2];
        let newlen = helper::from_slice2(value, &mut arr);
        Self { arr, len: newlen }
    }
}

/// Create buffer instance from &str
/// # Example
/// ```
/// use cbfr::cb::BFRDYN;
///
/// let b: BFRDYN<256> = "some string".into();
/// ```
/// # Panic
/// Panic if "some string" len > 256
/// ```
/// use cbfr::cb::BFRDYN;
/// // let _b: BFRDYN<4> = "Hello".into(); // should panic
/// ```
///
impl<const CAPACITY: usize> From<&str> for BFRDYN<CAPACITY> {
    fn from(value: &str) -> Self {
        let mut arr = [0u8; CAPACITY];
        helper::from_slice(value.as_bytes(), &mut arr);
        Self { arr, len: value.len() }
    } 
}

/// Create buffer instance from &str
/// # example
/// ```
/// use cbfr::BFRDYN;
/// let a: BFRDYN<125> = "wow amazing".into();
/// let partial = a.get_slice(0, 3).unwrap();
/// let mut b: BFRDYN<125> = partial.into();
///
/// assert_eq!("wow", b.to_string());
///
/// ```
/// # panic
/// Panic if "some string" len > 256
///
impl<const CAPACITY: usize> From<&[u8]> for BFRDYN<CAPACITY> {
    fn from(value: &[u8]) -> Self {
        let mut me = Self::new();
        helper::from_slice(value, &mut me.arr);
        me.len = value.len();
        me
    }
}

// NOTE: Review this code
// impl<const CAPACITY: usize> TryFrom<&String> for BFRDYN<CAPACITY> {
//     type Error = String;
//     fn try_from(value: &String) -> Result<Self, Self::Error> {
//         match CAPACITY.cmp(&value.len()) {
//             std::cmp::Ordering::Less => {
//                 let errmsg = format!("Not enough capacity. Buffer size is {} but try to store {}", CAPACITY, value.len());
//                 Err(errmsg)
//             },
//             _ => {
//                 let mut arr = [0u8; CAPACITY];
//                 for (i, v) in value.bytes().enumerate() {
//                     arr[i] = v
//                 }
//                 Ok(Self { arr, len: value.len() })
//             }
//         }
//     }
// }

/// clone trait
impl<const CAPACITY: usize> Clone for BFRDYN<CAPACITY> {
    fn clone(&self) -> Self { Self { arr: self.arr.clone(), len: self.len.clone() } }
}

/// partialEQ trait
/// # example
/// ```
/// use cbfr::cb::BFRDYN;
///
/// let a: BFRDYN<256> = "some string".into();
/// let mut b: BFRDYN<256> = "some string".into();
///
/// assert_eq!(true, (a==b));
///
/// b.append_ch('x');
/// assert_eq!(false, (a==b));
///
/// ```
///
impl<const CAPACITY: usize> PartialEq for BFRDYN<CAPACITY> {
    fn eq(&self, other: &Self) -> bool {
        helper::eq(&self.len, &self.arr, &other.len, &other.arr)
    } 
    fn ne(&self, other: &Self) -> bool {
        helper::ne(&self.len, &self.arr, &other.len, &other.arr)
    }
}

/// partialOrd trait
/// # example
/// ```
/// use cbfr::cb::BFRDYN;
///
/// let a: BFRDYN<256> = "string".into();
/// let mut b: BFRDYN<256> = "some string".into();
///
/// assert_eq!(true, (a<b));
/// assert_eq!(true, (b>=a));
///
/// ```
///
impl<const CAPACITY: usize> PartialOrd for BFRDYN<CAPACITY> {
    fn lt(&self, other: &Self) -> bool { self.checksum() < other.checksum() }
    fn gt(&self, other: &Self) -> bool { self.checksum() > other.checksum() }
    fn le(&self, other: &Self) -> bool { self.checksum() <= other.checksum() }
    fn ge(&self, other: &Self) -> bool { self.checksum() >= other.checksum() }
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> { Some(self.cmp(other)) }
}

impl<const CAPACITY: usize> Eq for BFRDYN<CAPACITY> {}
impl<const CAPACITY: usize> Ord for BFRDYN<CAPACITY> {
    fn max(self, other: Self) -> Self
        where Self: Sized 
    {
        if self.checksum() > other.checksum() { self } else { other }
    }
    fn min(self, other: Self) -> Self
        where Self: Sized 
    {
        if self.checksum() < other.checksum() { self } else { other }
    }
    fn clamp(self, min: Self, max: Self) -> Self
    where Self: Sized 
    {
        if self.checksum() < min.checksum() { min } 
        else if self.checksum() > max.checksum() { max }
        else { self }
    }
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        if self.checksum() < other.checksum() { std::cmp::Ordering::Less }
        else if self.checksum() == other.checksum() { std::cmp::Ordering::Equal }
        else { std::cmp::Ordering::Greater }
    }  
}

impl<const CAPACITY: usize> Add for BFRDYN<CAPACITY> {
    type Output = usize;
    fn add(self, rhs: Self) -> Self::Output {
        self.checksum() + rhs.checksum()
    }
}

impl<const CAPACITY: usize> Sub for BFRDYN<CAPACITY> {
    type Output = usize;
    fn sub(self, rhs: Self) -> Self::Output {
        self.checksum() - rhs.checksum()    
    }
}

impl<const CAPACITY: usize> Mul for BFRDYN<CAPACITY> {
    type Output = usize;
    fn mul(self, rhs: Self) -> Self::Output {
        self.checksum() * rhs.checksum()
    }
}

impl<const CAPACITY: usize> Div for BFRDYN<CAPACITY> {
    type Output = f64;
    fn div(self, rhs: Self) -> Self::Output {
        self.checksum() as f64 / rhs.checksum() as f64
    }
}

impl<const CAPACITY: usize> AsRef<str> for BFRDYN<CAPACITY> {
    /// return buffer as &str
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let b: BFRDYN<256> = "some string".into();
    /// assert_eq!("some string", <BFRDYN as AsRef<str>>::as_ref(&b));
    /// ```
    fn as_ref(&self) -> &str {
        unsafe {
            std::str::from_utf8_unchecked(&self.arr[0..self.len])
        } 
    }
}

impl<const CAPACITY: usize> AsRef<[u8]> for BFRDYN<CAPACITY> {
    /// return buffer as &[u8]
    /// # example
    /// ```
    /// use cbfr::BFRDYN;
    /// let b: BFRDYN<256> = "some string".into();
    /// let refslice = <BFRDYN as AsRef<[u8]>>::as_ref(&b);
    /// assert_eq!(b's', refslice[0]);
    /// assert_eq!(b' ', refslice[4]);
    /// assert_eq!(b't', refslice[6]);
    /// assert_eq!(11, refslice.len());
    /// ```
    fn as_ref(&self) -> &[u8] {
        &self.arr[0..self.len]
    }
}

impl<const CAPACITY: usize> Borrow<[u8]> for BFRDYN<CAPACITY> {
    fn borrow(&self) -> &[u8] {
        self.as_ref()
    }
}

impl<const CAPACITY: usize> BorrowMut<[u8]> for BFRDYN<CAPACITY> {
    fn borrow_mut(&mut self) -> &mut [u8] {
        &mut self.arr
    }
}

impl<const CAPACITY: usize> std::ops::Deref for BFRDYN<CAPACITY> {
    type Target = [u8];
    ///
    /// use cbfr::BFRDYN;
    /// let b = "some string".into();
    /// let slice = *b;
    /// assert_eq!(slice[0], 's');
    /// assert_eq!(slice[3], 'e');
    /// assert_eq!(slice[10], 'g');
    ///
    fn deref(&self) -> &Self::Target {
        self.as_ref() 
    } 
}

impl BFRDYN {
    ///
    /// Create buffer with default capacity (default capacity is 256)
    /// 
    pub const fn def() -> Self {
        Self { arr: [0u8; DEFCAPACITY], len: 0 }
    }
    ///
    /// Create buffer with generic const capacity
    /// # Example:
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let myb = BFRDYN::withcap::<64>();
    /// let cap = myb.capacity();
    /// assert_eq!(64, cap);
    /// ```
    pub fn withcap<const CAP: usize>() -> BFRDYN<CAP> {
        BFRDYN {
            arr: [0u8; CAP],
            len: 0
        }        
    }
}


// non trait implementations
impl<const CAPACITY: usize> BFRDYN<CAPACITY> {
    /// create new buffer with generic constant capacity
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let b = BFRDYN::<256>::new();
    /// assert_eq!("", b.to_string());
    /// assert_eq!(0, b.len());
    /// assert_eq!(256, b.capacity());
    /// ```
    ///
    pub const fn new() -> Self { Self { arr: [0u8; CAPACITY], len: 0 } }

    /// Create new buffer by copying value from exisiting slice 
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// const slice: &[u8] = "Admin123".as_bytes();
    ///
    /// const buf: BFRDYN<256> = BFRDYN::from_slice(slice);
    /// dbg!("{}", buf.len());
    /// assert_eq!(8, buf.len());
    /// assert_eq!("Admin123", buf.as_str());
    /// ```
    ///
    pub const fn from_slice(slice: &[u8]) -> Self {
        let me = Self::new();
        assert!(slice.len() <= me.arr.len(), "Not enough capacity");
        let arr_ptr = me.arr.as_slice().as_ptr() as *mut u8;   //NOTE: WTF...?
        let len_ptr = (&me.len) as *const usize;
        unsafe {
            std::ptr::copy(slice.as_ptr(), arr_ptr, slice.len());
            std::ptr::copy(&slice.len() as *const usize, len_ptr as *mut usize, 1);

            // if slice.len() <= me.arr.len() {
            //     std::ptr::copy(slice.as_ptr(), ptr, slice.len())
            // } else {
            //     std::ptr::copy(slice.as_ptr(), ptr, me.arr.len())
            // }
        }
        me
    }

    /// return buffer as &str
    /// this function was deprecated on the previous version, but actually this
    /// function is very handy on some specific situation so we bring back this function
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let b: BFRDYN<256> = "some string".into();
    /// assert_eq!("some string", b.as_str());
    /// ```
    pub fn as_str(&self) -> &str {
        unsafe {
            std::str::from_utf8_unchecked(&self.arr[0..self.len])
        }
    }

    /// return buffer as array of bytes
    /// # example
    /// ```
    /// use cbfr::BFRDYN;
    /// let b: BFRDYN<256> = "abc".into();
    /// let mut iter = b.as_bytes().into_iter();
    ///
    /// assert_eq!(b'a', iter.next().unwrap());
    /// assert_eq!(b'b', iter.next().unwrap());
    /// assert_eq!(b'c', iter.next().unwrap());
    /// ```
    pub const fn as_bytes(&self) -> [u8; CAPACITY] {
        self.arr
    }

    /// This function return &mut of internal array that
    /// you can use to directly modify the internal array.
    /// warning: modify the internal array directly is dangerous!. 
    /// See the example below to find out why.
    /// ## Here some safe methods you may interested to.
    /// - If you want just a copy of the internal array then use [as_bytes]
    /// - If you want the internal array and no longer need for
    /// the buffer, then use [take_inner]
    /// # Example1 (this is Ok)
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN = "Hello".into();
    /// println!("Before mutate: {b}");
    ///
    /// let mr = unsafe { b.bytes_mut() };
    /// mr[0] = 'Z' as u8;
    /// println!("After mutate: {b}");
    /// assert_eq!("Zello", <BFRDYN as AsRef<str>>::as_ref(&b));
    /// ```
    /// # Example2 (this is NOT Ok)
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN = "Hello".into();
    /// println!("Before mutate: {b}");
    ///
    /// let mr = unsafe { b.bytes_mut() };
    /// mr[5] = b'!';   // we expect buffer to be "Hello!"
    /// println!("After mutate: {b}");
    /// assert_eq!("Hello", <BFRDYN as AsRef<str>>::as_ref(&b));
    /// ```
    /// # Example3 (this is Ok)
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN = "Hello".into();
    /// println!("Before mutate: {b}");
    ///
    /// let mr = unsafe { b.bytes_mut() };
    /// mr[5] = b'!';   // we expect buffer to be "Hello!"
    /// unsafe { b.increase_len(1); }   // manually sync buffer len
    /// println!("After mutate: {b}");
    /// assert_eq!("Hello!", <BFRDYN as AsRef<str>>::as_ref(&b));
    /// ```
    pub unsafe fn bytes_mut(&mut self) -> &mut[u8; CAPACITY] {
        &mut self.arr
    }

    /// Take the inner array and destroy the buffer
    /// Just after this function have called, buffer will be dropped
    /// # Example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let b: BFRDYN = "Hi".into();
    /// let inner = b.take_inner();
    /// let mut array = [0; 256];
    /// array[0] = b'H';
    /// array[1] = b'i';
    /// assert_eq!(array, inner);
    /// ```
    pub fn take_inner(self) -> [u8; CAPACITY] {
        self.arr
    }

    /// Automatically update buffer len
    /// This function will automatically sync len appropriately
    /// This code takes O(n) time complexity which is
    /// slower in comparing to increase_len and decrease_len method.
    /// If you know exactly the correct len, consider using
    /// increase_len or decrease_len. This method should be
    /// use only in case where you do not have information
    /// of the correct len of the buffer.
    /// # Example
    /// ```
    /// use cbfr::BFRDYN;
    /// let mut b: BFRDYN = "Hello".into();
    /// println!("Before mutate: {b}");
    ///
    /// let mr = unsafe {b.bytes_mut()};
    /// mr[5] = b'!';   // we expect buffer to be "Hello!"
    /// b.auto_len();   // manually sync buffer len
    /// println!("After mutate: {b}");
    /// assert_eq!("Hello!", <BFRDYN as AsRef<str>>::as_ref(&b));
    /// assert_eq!(6, b.len());
    /// ```
    pub fn auto_len(&mut self) {
        let mut newlen = 0;
        for i in self.arr.iter() {
            if *i != 0u8 { newlen += 1 }
            else { break; }
        }
        self.len = newlen;
    }

    /// Manually increase buffer len
    /// warning: manually modify buffer len is dangerous!. 
    /// # Example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN = "Hello".into();
    /// println!("Before mutate: {b}");
    ///
    /// let mr = unsafe { b.bytes_mut() };
    /// mr[5] = b'!';   // we expect buffer to be "Hello!"
    /// unsafe { b.increase_len(1); }   // manually sync buffer len
    /// println!("After mutate: {b}");
    /// assert_eq!("Hello!", <BFRDYN as AsRef<str>>::as_ref(&b));
    /// ```
    pub unsafe fn increase_len(&mut self, by: usize) {
        self.len += by 
    }

    /// Manually decrease buffer len
    /// warning: manually modify buffer len is dangerous!. 
    /// # Example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN = "Hello".into();
    /// println!("Before mutate: {b}");
    ///
    /// let mr = unsafe { b.bytes_mut() };
    /// mr[3] = b'o';   // we expect buffer to be "Heloo"
    /// mr[4] = 0;      // we expect buffer to be "Helo"
    /// unsafe { b.decrease_len(1); }   // manually sync buffer len
    /// println!("After mutate: {b}");
    /// assert_eq!("Helo", <BFRDYN as AsRef<str>>::as_ref(&b));
    /// ```
    pub unsafe fn decrease_len(&mut self, by: usize) {
        self.len -= by 
    }

    /// get buffer capacity
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let b: BFRDYN = "AbCd".into(); // default capacity is 256
    ///
    /// assert_eq!(256, b.capacity());
    /// ```
    pub const fn capacity(&self) -> usize { self.arr.len() }

    /// get buffer len
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let b: BFRDYN = "AbCd".into();
    ///
    /// assert_eq!(4, b.len());
    /// ```
    pub const fn len(&self) -> usize { self.len }

    /// perform checksum to all bytes data inside buffer
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let b: BFRDYN<125> = "Aa".into();
    ///
    /// assert_eq!((65+65+32), b.checksum());
    ///
    /// ```
    ///
    pub const fn checksum(&self) -> usize {
        let mut result = 0;

        // NOTE: for loop is not supported on const function
        // for c in self.arr.iter() {
        //     result += *c as usize;
        // }

        let mut i = 0;
        while i < self.len {
            result += self.arr[i] as usize;
            i += 1;
        }
        result
    }

    /// Check if buffer contain criteria, return true if yes otherwise return false.
    /// This function produce the same result with 'contains', the difference is
    /// this function takes 0(n*m) time complexity while contains takes O(n).
    /// But this function is const and can be evaluated on compile time
    /// so this function can run faster (for most of the cases).
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let buf: BFRDYN<125> = "Admin123".into();
    ///
    /// assert!(buf.contain_str("A"));
    /// assert!(buf.contain_str("Ad"));
    /// assert!(buf.contain_str("dmi"));
    /// assert!(buf.contain_str("dmin"));
    /// assert!(buf.contain_str("in"));
    /// assert!(buf.contain_str("n"));
    /// assert!(buf.contain_str("123"));
    /// assert_eq!(false, buf.contain_str("x"));
    /// ```
    /// 
    /// # const Example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// const slice: &[u8] = "Admin123User".as_bytes();
    /// const buf: BFRDYN<256> = BFRDYN::from_slice(slice);
    ///
    /// const has123: bool = buf.contain_str("123");
    /// assert!(has123);
    /// ```
    ///
    pub const fn contain_str(&self, criteria: &str) -> bool {
        let mut i = 0;
        if criteria.len() > self.len { return false; }
        let criteria = criteria.as_bytes();
        while i < (1 + self.len - criteria.len()) {
            let mut j = 0;
            let mut current = criteria[j];
            while current == self.arr[i+j] {
                j += 1;
                if j >= criteria.len() { return true; }
                current = criteria[j];
            }
            i += 1;
        }
        false
    }

    /// Check if buffer contain criteria, return true if yes otherwise return false.
    /// This function produce the same result with 'contain_str', the difference is
    /// this function takes 0(n) time complexity (contain_str takes O(n*m))
    /// unfortunately this function is not const.
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let buf: BFRDYN<125> = "Admin123".into();
    ///
    /// assert!(buf.contains("A"));
    /// assert!(buf.contains("Ad"));
    /// assert!(buf.contains("dmi"));
    /// assert!(buf.contains("dmin"));
    /// assert!(buf.contains("in"));
    /// assert!(buf.contains("n"));
    /// assert!(buf.contains("123"));
    /// assert_eq!(false, buf.contains("x"));
    /// ```
    ///
    pub fn contains(&self, criteria: &str) -> bool {
        if criteria.len() > self.len { return false; }
        let mut i = 0;
        while i <= (self.len - criteria.len()) {
            let current = &self.arr[i..criteria.len()+i];
            if criteria.as_bytes() == current { return true; } 
            i += 1;
        }
        false
    }

    /// get the last value as byte inside a buffer
    /// if it is empty, this function return 0u8
    /// #example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let b: BFRDYN<256> = "some string".into();
    /// assert_eq!(103, b.last());
    ///
    /// let c = BFRDYN::<125>::new();
    /// assert_eq!(0u8, c.last());
    /// ```
    ///
    pub const fn last(&self) -> u8 {
        if self.len > 0 {
            self.arr[self.len-1]
        }
        else { 0u8 }
    }

    /// get the last char inside a buffer
    /// if char is empty, this function return '\0'
    /// #example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let b: BFRDYN<256> = "some string".into();
    /// assert_eq!('g', b.last_char());
    ///
    /// let c = BFRDYN::<125>::new();
    /// assert_eq!('\0', c.last_char());
    /// ```
    ///
    pub fn last_char(&self) -> char {
        if self.len > 0 {
            self.arr[self.len-1].into()
        }
        else { '\0' }
    }

    /// clear all data inside a buffer, causing all data to be
    /// revert back to buffer default value that is '\0' or 0u8
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN<125> = "some string".into();
    /// b.clear();
    /// assert_eq!(0, b.len());
    /// assert_eq!("", b.as_str());
    /// assert_eq!("", b.to_string());
    /// ```
    ///
    pub fn clear(&mut self) {
        self.arr = [0u8; CAPACITY];
        self.len = 0;
    }

    /// prepend buffer self with other without any error checking
    /// offer performance boost (no error checking logic) but with a risk.
    /// After prepend, buffer self will contain buffer other old value +
    /// buffer self old value and buffer other will contain old
    /// buffer self value
    /// This function may panic if you prepend value with len
    /// larger than buffer capacity.
    /// # Example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut a: BFRDYN<125> = "I love ".into();
    /// let mut b: BFRDYN<125> = "Banana".into();
    ///
    /// assert_eq!("I love ", a.to_string());
    /// assert_eq!("Banana", b.to_string());
    ///
    /// unsafe {b.prepend_unchecked(&mut a);}
    ///
    /// assert_eq!("Banana", a.to_string());
    /// assert_eq!("I love Banana", b.to_string());
    /// assert_eq!(6, a.len());
    /// assert_eq!(13, b.len());
    /// ```
    /// # Panic
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// // create a small buffer with capacity of 4;
    /// let mut very_small: BFRDYN<4> = "Rust".into();
    /// let mut other: BFRDYN<4> = "y!".into();
    /// // unsafe {very_small.prepend_unchecked(&mut other);} // should panic
    /// // note: if you change the capacity of buffer to 6 
    /// // or greater the code above will not panic
    /// ```
    pub unsafe fn prepend_unchecked(&mut self, other: &mut Self) {
        mem::swap(&mut self.arr, &mut other.arr);
        for i in 0..self.len {
            self.arr[other.len+i] = other.arr[i]
        }
        
        // NOTE: make const fun when mem::swap finally support const
        // let mut i = 0;
        // while i < self.len {
        //     self.arr[other.len+i] = other.arr[i];
        //     i += 1;
        // }
        
        // swap len
        let self_len_temp = self.len;
        self.len += other.len;
        other.len = self_len_temp;
    }

    /// prepend current buffer with another buffer
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let mut a: BFRDYN<256> = "coding".into();
    /// let b: BFRDYN<256> = "I love ".into();
    ///
    /// a.prepend(b);
    /// assert_eq!("I love coding", a.as_str());
    /// assert_eq!(13, a.len());
    /// ```
    ///
    pub fn prepend(&mut self, mut other: Self) -> NecResult {
        let total_len = self.len + other.len;
        if total_len <= self.capacity() {
            unsafe {self.prepend_unchecked(&mut other);}
            Ok(())
        } else {
            Err(err::NotEnoughCapacity::throw(self.capacity(), total_len))
        }
    }

    /// prepend buffer with &str
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let mut b: BFRDYN<256> = "coding".into();
    /// let some_str = "I love ";
    ///
    /// b.prepend_str(some_str);
    /// assert_eq!("I love coding", b.as_str());
    /// assert_eq!(13, b.len());
    /// ```
    ///
    pub fn prepend_str(&mut self, text: &str) -> NecResult {
        let total_len = self.len + text.len();
        if total_len <= self.capacity() {
            let mut other: Self = text.into();
            unsafe {self.prepend_unchecked(&mut other);}
            Ok(())
        } else {
            Err(err::NotEnoughCapacity::throw(self.capacity(), total_len))
        }
    }

    /// append current buffer with another buffer
    /// # example 
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut a: BFRDYN<125> = "I love".into();
    /// let b: BFRDYN<125> = " coding".into();
    ///
    /// a.append(b);
    /// assert_eq!("I love coding", a.to_string());
    /// assert_eq!(13, a.len());
    /// ```
    ///
    pub fn append(&mut self, other: Self) -> NecResult {
        let total_len = self.len + other.len;
        if total_len <= self.capacity() {
            for i in 0..(other.len) {
                self.arr[self.len+i] = other.arr[i]
            }
            self.len += other.len;
            Ok(())
        } else {
            Err(err::NotEnoughCapacity::throw(self.capacity(), total_len))
        }
    }

    /// append current buffer with &str
    /// # example 
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN<125> = "I love".into();
    /// let some_str = " coding";
    ///
    /// b.append_str(some_str);
    /// assert_eq!("I love coding", b.to_string());
    /// assert_eq!(13, b.len());
    /// ```
    ///
    pub fn append_str(&mut self, text: &str) -> NecResult {
        let total_len = self.len + text.len();
        if total_len <= self.capacity() {
            for i in 0..text.len() {
                self.arr[self.len+i] = text.as_bytes()[i]
            }
            self.len += text.len();
            Ok(())
        } else {
            Err(err::NotEnoughCapacity::throw(self.capacity(), total_len))
        }
    }

    /// append current buffer with &ch
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN<125> = "Happy condin".into();
    ///
    /// b.append_ch('g');
    /// assert_eq!("Happy conding", b.to_string());
    /// assert_eq!(13, b.len());
    /// ```
    ///
    pub fn append_ch(&mut self, c: char) -> NecResult {
        let total_len = self.len + c.len_utf8();
        if total_len <= self.capacity() {
            for i in 0..c.len_utf8() {
                self.arr[self.len+i] = c as u8
            }
            self.len += c.len_utf8();
            Ok(())
        } else {
            Err(err::NotEnoughCapacity::throw(self.capacity(), total_len))
        }
    }

    /// shift value to right, leave original value
    /// this function will expand the buffer value len by 1
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN<256> = "Amazing".into();
    /// b.rshift(6).unwrap();
    /// assert_eq!("Amazingg", b.as_str());
    /// assert_eq!(8, b.len());
    /// ```
    ///
    pub fn rshift(&mut self, pos: usize) -> IidxResult {
        if pos < self.len && self.len < self.capacity() {
            let mut idx = self.len;
            while idx > pos {
                self.arr[idx] = self.arr[idx-1];
                idx -= 1;
            }
            self.len += 1;
            Ok(())
        } else {
            Err(err::InvalidIndex::throw(self.len, pos))
        }
    }
    
    /// shift value to left 
    /// this function will shrink the buffer len by 1
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN<256> = "Amazing".into();
    /// b.lshift(0).unwrap();
    /// assert_eq!("mazing", b.as_str());
    /// assert_eq!(6, b.len());
    /// ```
    ///
    pub fn lshift(&mut self, pos: usize) -> IidxResult {
        if pos < self.len {
            for i in pos..self.len {
                self.arr[i] = self.arr[i+1]
            }
            self.arr[self.len] = 0u8;
            self.len -= 1;
            Ok(())
        } else {
            Err(err::InvalidIndex::throw(self.len, pos))
        }
    }

    /// take and remove a value from buffer
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN<256> = "AmazZing".into();
    /// let x = b.take(4).unwrap();
    /// assert_eq!("Amazing", b.as_str());
    /// assert_eq!(7, b.len());
    /// assert_eq!('Z', x as char);
    /// ```
    ///
    pub fn take(&mut self, pos: usize) -> Option<u8> {
        if pos < self.len {
            let result = self.arr[pos];
            self.lshift(pos).unwrap();
            Some(result)
        }
        else { None }
    }

    /// insert with another buffer at a given position
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut a: BFRDYN<256> = "Amng".into();
    /// let b: BFRDYN<256> = "azi".into();
    /// a.insert(b, 2).unwrap();
    /// assert_eq!("Amazing", a.as_str());
    /// assert_eq!(7, a.len());
    /// ```
    ///
    pub fn insert(&mut self, other: Self, pos: usize) -> NecResult {
        let total_len = self.len + other.len;
        if total_len <= self.capacity() && pos < self.len {
            let mut idx = pos;
            for i in 0..other.len {
                self.rshift(idx)?;
                self.arr[idx] = other.arr[i];
                idx += 1;
            }
            Ok(())
        } else {
            Err(err::NotEnoughCapacity::throw(self.capacity(), total_len))
        }
    }
    
    /// insert with a char at a given position
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN<256> = "Amaing".into();
    /// b.insert_ch('Z', 3).unwrap();
    /// assert_eq!("AmaZing", b.as_str());
    /// assert_eq!(7, b.len());
    /// ```
    ///
    pub fn insert_ch(&mut self, c: char, pos: usize) -> NecResult {
        if self.len < self.capacity() {
            self.rshift(pos)?;
            self.arr[pos] = c as u8;
            Ok(())
        }
        else {
            Err(err::NotEnoughCapacity::throw(self.capacity(), self.len+1))
        }
    }

    /// reverse order of items in buffer
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN<256> = "12345".into();
    /// b.reverse();
    /// assert_eq!("54321", b.as_str());
    /// assert_eq!(5, b.len());
    /// ```
    ///
    pub fn reverse(&mut self) {
        let mid = self.len/2;
        let mut idx = (0usize, self.len-1);
        while idx.0 < mid {
            let temp = self.arr[idx.0];
            self.arr[idx.0] = self.arr[idx.1];
            self.arr[idx.1] = temp;
            idx.0 += 1;
            idx.1 -= 1;
        }
    }

    /// sort items in buffer using Isertion Sort Algorithm
    /// this method takes O(n*log(n)) time complexity
    /// this method takes O(1) space complexity
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN<256> = "cgahMb".into();
    /// b.isort();
    /// assert_eq!("Mabcgh", b.as_str());
    /// assert_eq!(6, b.len());
    /// ```
    ///
    pub fn isort(&mut self) {
        for i in 1..self.len() {
            let mut j; 
            for x in 0..i {
                j = i - x;
                if self.arr[j] < self.arr[j-1] {
                    let temp = self.arr[j];
                    self.arr[j] = self.arr[j-1];
                    self.arr[j-1] = temp;
                } else { break; }
            }
        }
    }

    /// sort (descending) items in buffer using Isertion Sort Algorithm
    /// this method takes O(n*log(n)) time complexity
    /// this method takes O(1) space complexity
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN<256> = "cgahMb".into();
    /// b.isort_desc();
    /// assert_eq!("hgcbaM", b.as_str());
    /// assert_eq!(6, b.len());
    /// ```
    ///
    pub fn isort_desc(&mut self) {
        for i in 1..self.len() {
            let mut j; 
            for x in 0..i {
                j = i - x;
                if self.arr[j] > self.arr[j-1] {
                    let temp = self.arr[j];
                    self.arr[j] = self.arr[j-1];
                    self.arr[j-1] = temp;
                } else { break; }
            }
        }
    }

    /// sort items in buffer
    /// this method use linear sort algorithm with O(n * n) time complexity
    /// this method takes O(1) space complexity
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN<256> = "cgahb".into();
    /// b.sort();
    /// assert_eq!("abcgh", b.as_str());
    /// assert_eq!(5, b.len());
    /// ```
    ///
    pub fn sort(&mut self) {
        let mut sorted = false;
        while !sorted {
            sorted = true;
            for i in 0..(self.len-1) {
                if self.arr[i+1] < self.arr[i] {
                    let temp = self.arr[i];
                    self.arr[i] = self.arr[i+1];
                    self.arr[i+1] = temp;
                    sorted = false;
                }
            }
        }
    }

    /// sort items in buffer descending
    /// this method use linear sort algorithm with O(n * n) time complexity
    /// this method takes O(1) space complexity
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN<256> = "cgahb".into();
    /// b.sort_desc();
    /// assert_eq!("hgcba", b.as_str());
    /// assert_eq!(5, b.len());
    /// ```
    ///
    pub fn sort_desc(&mut self) {
        let mut sorted = false;
        while !sorted {
            sorted = true;
            for i in 0..(self.len-1) {
                if self.arr[i+1] > self.arr[i] {
                    let temp = self.arr[i];
                    self.arr[i] = self.arr[i+1];
                    self.arr[i+1] = temp;
                    sorted = false;
                }
            }
        }
    }

    /// trim space on left side
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN<256> = "  L ove".into();
    /// b.ltrim();
    /// assert_eq!("L ove", b.as_str());
    /// assert_eq!(5, b.len());
    /// ```
    ///
    pub fn ltrim(&mut self) {
        let mut idx = self.len;
        while self.arr[0] == ' ' as u8 && idx > 1 {
            self.lshift(0).unwrap();
            idx -= 1;
        }
    }

    /// trim space on right side
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN<256> = "Lov e  ".into();
    /// b.rtrim();
    /// assert_eq!("Lov e", b.as_str());
    /// assert_eq!(5, b.len());
    /// ```
    ///
    pub fn rtrim(&mut self) {
        while self.arr[self.len-1] == ' ' as u8 && self.len > 1 {
            self.arr[self.len-1] = 0u8;
            self.len -= 1;
        }
    }

    /// trim space
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN<256> = " Lov e  ".into();
    /// b.trim();
    /// assert_eq!("Lov e", b.as_str());
    /// assert_eq!(5, b.len());
    /// ```
    ///
    pub fn trim(&mut self) { self.ltrim(); self.rtrim(); }

    /// convert to lowercase
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN<256> = "LoVE".into();
    /// b.lower();
    /// assert_eq!("love", b.as_str());
    /// assert_eq!(4, b.len());
    /// ```
    ///
    pub fn lower(&mut self) {
        for (i, c) in self.arr.iter_mut().enumerate() {
            if i > (self.len-1) { break; }
            if *c <= 90 && *c >= 65 {
                *c = *c + 32;
            }
        }

        // Old code
        // for c in self.arr.iter_mut() {
        //     if *c <= 90 && *c >= 65 {
        //         *c = *c + 32;
        //     }
        // }
    }

    /// convert to uppercase
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN<256> = "loVe".into();
    /// b.upper();
    /// assert_eq!("LOVE", b.as_str());
    /// assert_eq!(4, b.len());
    /// ```
    ///
    pub fn upper(&mut self) {
        for (i, c) in self.arr.iter_mut().enumerate() {
            if i > (self.len-1) { break; }
            if *c >= 97 && *c <= 122 {
                *c = *c - 32;
            }
        }

        // Old code
        // for c in self.arr.iter_mut() {
        //     if *c >= 97 && *c <= 122 {
        //         *c = *c - 32;
        //     }
        // }
    }

    /// to title
    /// convert all value to lowercase except for the first letter
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN<256> = "lOVE".into();
    /// b.title();
    /// assert_eq!("Love", b.as_str());
    /// assert_eq!(4, b.len());
    /// ```
    ///
    pub fn title(&mut self) {
        self.lower();
        self.arr[0] -= 32;
    }
    
    /// to proper
    /// convert all value to lowercase but uppercase for every first letters
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    /// let mut b: BFRDYN<256> = "damN i loVe iNdoNESia".into();
    ///
    /// b.proper();
    /// assert_eq!("Damn I Love Indonesia", b.as_str());
    /// assert_eq!(21, b.len());
    /// ```
    pub fn proper(&mut self) {
        let mut change_next = false;
        self.title();
        for (idx, c) in self.arr.iter_mut().enumerate() {
            if change_next && *c != ' ' as u8 {
                *c = *c - 32;
                change_next = false;
            }
            if idx < self.len-1 && *c == ' ' as u8 {
                change_next = true;
            }
        }
    }

    /// get slice without checking if 'start' and 'end' is a valid index
    /// this function may return unexpected result if 
    /// the start or end value lies beyond valid index
    /// # Example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let b: BFRDYN<256> = "I love you so much".into();
    /// unsafe {
    ///     let partial = b.get_slice_unchecked(2,6);
    ///     assert_eq!('l', partial[0] as char);
    ///     assert_eq!('o', partial[1] as char);
    ///     assert_eq!('v', partial[2] as char);
    ///     assert_eq!('e', partial[3] as char);
    /// }
    /// ```
    /// # Panic
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let b: BFRDYN<32> = "texting while coding is unsafe".into();
    /// unsafe {
    ///     // let partial = b.get_slice_unchecked(20, 50); // should panic
    /// }
    /// ```
    pub unsafe fn get_slice_unchecked(&self, start: usize, end: usize) -> &[u8] {
        &self.arr[start..end]
    }

    /// get slice
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let b: BFRDYN<256> = "I love you so much".into();
    /// let partial = b.get_slice(2,6).unwrap();
    /// assert_eq!('l', partial[0] as char);
    /// assert_eq!('o', partial[1] as char);
    /// assert_eq!('v', partial[2] as char);
    /// assert_eq!('e', partial[3] as char);
    /// ```
    ///
    pub fn get_slice(&self, start: usize, end: usize) -> Result<&[u8], err::InvalidIndex> {
        if start >= (self.len-1) || end > (self.len) || start > end {
            Err(err::InvalidIndex::throw(start, end))
        } else {
            Ok(&self.arr[start..end])
        }
    }

    /// split by char and return `Vec<String>`, include char criteria to next item
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let b: BFRDYN<256> = "I, love, you".into();
    /// let mut words: Vec<String> = b.to_vecir(',');
    ///
    /// assert_eq!(", you", words.pop().unwrap());
    /// assert_eq!(", love", words.pop().unwrap());
    /// assert_eq!("I", words.pop().unwrap());
    /// ```
    ///
    pub fn to_vecir(&self, c: char) -> Vec<String> {
        let mut v = Vec::<String>::new();
        let mut start: usize = 0;
        let mut end: usize = 0;
        for i in self.arr {
            end += 1;
            if i == c as u8 {
                let x = &self.arr[start..end-1];
                let bfr: BFRDYN<CAPACITY> = x.into();
                v.push(bfr.to_string());
                start = end-1;
            }
        }
        let last = &self.arr[start..self.len];
        let bfr: BFRDYN<CAPACITY> = last.into();
        v.push(bfr.to_string());
        v
    }

    /// split by char and return `Vec<String>`, include char criteria to current item
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let b: BFRDYN<256> = "I, love, you".into();
    /// let mut words: Vec<String> = b.to_vecil(',');
    ///
    /// assert_eq!(" you", words.pop().unwrap());
    /// assert_eq!(" love,", words.pop().unwrap());
    /// assert_eq!("I,", words.pop().unwrap());
    /// ```
    ///
    pub fn to_vecil(&self, c: char) -> Vec<String> {
        let mut v = Vec::<String>::new();
        let mut start: usize = 0;
        let mut end: usize = 0;
        for i in self.arr {
            end += 1;
            if i == c as u8 {
                let x = &self.arr[start..end];
                let bfr: BFRDYN<CAPACITY> = x.into();
                v.push(bfr.to_string());
                start = end;
            }
        }
        let last = &self.arr[start..self.len];
        let bfr: BFRDYN<CAPACITY> = last.into();
        v.push(bfr.to_string());
        v
    }

    /// split by char and return `Vec<String>`, exclude the char criteria
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let b: BFRDYN<256> = "I,love,you".into();
    /// let mut words: Vec<String> = b.to_vec(',');
    ///
    /// assert_eq!("you", words.pop().unwrap());
    /// assert_eq!("love", words.pop().unwrap());
    /// assert_eq!("I", words.pop().unwrap());
    /// ```
    ///
    pub fn to_vec(&self, c: char) -> Vec<String> {
        let mut v = Vec::<String>::new();
        let mut start: usize = 0;
        let mut end: usize = 0;
        for i in self.arr {
            end += 1;
            if i == c as u8 {
                let x = &self.arr[start..end-1];
                let bfr: BFRDYN<CAPACITY> = x.into();
                v.push(bfr.to_string());
                start = end;
            }
        }
        let last = &self.arr[start..self.len];
        let bfr: BFRDYN<CAPACITY> = last.into();
        v.push(bfr.to_string());
        v
    }

    /// split by &str and return `Vec<String>`
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let b: BFRDYN<256> = "I,,will,always,,remember,you".into();
    /// let mut words: Vec<String> = b.to_vec2(",,");
    ///
    /// assert_eq!("remember,you", words.pop().unwrap());
    /// assert_eq!("will,always", words.pop().unwrap());
    /// assert_eq!("I", words.pop().unwrap());
    /// ```
    ///
    pub fn to_vec2(&self, s: &str) -> Vec<String> {
        let mut v = Vec::<String>::new();
        let mut start: usize = 0;
        for (i, _) in self.arr.iter().enumerate() {
            if i + s.len() > self.len { break; }
            if self.arr[i..i+s.len()] == s.as_bytes()[..] {
                let x = &self.arr[start..i];
                let bfr: BFRDYN<CAPACITY> = x.into();
                v.push(bfr.to_string());
                start = i+s.len();
            }
        }
        let last = &self.arr[start..self.len];
        let bfr: BFRDYN<CAPACITY> = last.into();
        v.push(bfr.to_string());
        v
    }

    /// split by &str and skip if next char equal to 'r'
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let b: BFRDYN<256> = r#""id":"123","model": "davinci""#.into();
    /// let mut parsed = b.to_vecr("\",", '#');
    ///
    /// assert_eq!(r#""model": "davinci""#, parsed.pop().unwrap());
    /// assert_eq!(r#""id":"123"#, parsed.pop().unwrap());
    ///
    /// ```
    ///
    pub fn to_vecr(&self, s: &str, r: char) -> Vec<String> {
        let mut v = Vec::<String>::new();
        let mut start: usize = 0;
        for (i, _) in self.arr.iter().enumerate() {
            if i + s.len() > self.len { break; }
            let end = i+s.len();
            if (self.arr[i..end] == s.as_bytes()[..]) && self.arr[end..end+1][0] != r as u8 {
                let x = &self.arr[start..i];
                let bfr: BFRDYN<CAPACITY> = x.into();
                v.push(bfr.to_string());
                start = i+s.len();
            }
        }
        let last = &self.arr[start..self.len];
        let bfr: BFRDYN<CAPACITY> = last.into();
        v.push(bfr.to_string());
        v
    }

    /// split by &str (plus left right char) and return `Vec<String>`
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let b: BFRDYN<256> = r#""id":"123","name":"Bill""#.into();
    /// let mut words: Vec<String> = b.to_veclr(',', '"', '"');
    ///
    /// assert_eq!(r#""name":"Bill""#, words.pop().unwrap());
    /// assert_eq!(r#""id":"123""#, words.pop().unwrap());
    /// ```
    ///
    pub fn to_veclr(&self, c: char, lchar: char, rchar: char) -> Vec<String> {
        let mut v = Vec::<String>::new();
        let mut start: usize = 0;
        for (i, _) in self.arr.iter().enumerate() {
            if i == 1 { continue; }
            if i+1 > self.len { break; }
            let end = i+1;
            if self.arr[i..end][0] == c as u8 && (self.arr[end-2..end-1][0] == lchar as u8) && (self.arr[end..end+1][0] == rchar as u8) {
                let x = &self.arr[start..i];
                let bfr: BFRDYN<CAPACITY> = x.into();
                v.push(bfr.to_string());
                start = i+1;
            }
        }
        let last = &self.arr[start..self.len];
        let bfr: BFRDYN<CAPACITY> = last.into();
        v.push(bfr.to_string());
        v
    }

    //=============NEW===============
    /// split by &char (exclude the criteria) and return Option<(Self, Self)>
    /// or return None if the criteria didn't match
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let b: BFRDYN<256> = "user332@email.com".into();
    /// let (username, email_provider) = b.split('@').unwrap();
    ///
    /// assert_eq!("user332", username.as_str());
    /// assert_eq!("email.com", email_provider.as_str());
    /// ```
    ///
    pub fn split(self, criteria: char) -> Option<(Self, Self)> {
        for (i, c) in self.arr.iter().enumerate() {
            if *c as char == criteria {
                let left: Self = self.arr[0..i].into();
                let right: Self = self.arr[i+1..self.len].into();
                return Some((left, right));
            }
        }
        None
    }
    /// split by &char (include the criteria) and return Option<(Self, Self)>
    /// or return None if the criteria didn't match
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let b: BFRDYN<256> = "user332@email.com".into();
    /// let (username, email_provider) = b.split_incl('@').unwrap();
    ///
    /// assert_eq!("user332", username.as_str());
    /// assert_eq!("@email.com", email_provider.as_str());
    /// ```
    ///
    pub fn split_incl(self, criteria: char) -> Option<(Self, Self)> {
        for (i, c) in self.arr.iter().enumerate() {
            if *c as char == criteria {
                let left: Self = self.arr[0..i].into();
                let right: Self = self.arr[i..self.len].into();
                return Some((left, right));
            }
        }
        None
    }
    /// split by &char (include the criteria to the left) and return Option<(Self, Self)>
    /// or return None if the criteria didn't match
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let b: BFRDYN<256> = "user332@email.com".into();
    /// let (username, email_provider) = b.split_incl_left('@').unwrap();
    ///
    /// assert_eq!("user332@", username.as_str());
    /// assert_eq!("email.com", email_provider.as_str());
    /// ```
    ///
    pub fn split_incl_left(self, criteria: char) -> Option<(Self, Self)> {
        for (i, c) in self.arr.iter().enumerate() {
            if *c as char == criteria {
                let left: Self = self.arr[0..i+1].into();
                let right: Self = self.arr[i+1..self.len].into();
                return Some((left, right));
            }
        }
        None
    }
    /// split by &str (exclude the criteria) and return Option<(Self, Self)>
    /// or return None if the criteria didn't match
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let b: BFRDYN<256> = "user123//hello world//message".into();
    /// let (left, right) = b.split2("//").unwrap();
    ///
    /// assert_eq!("user123", left.as_str());
    /// assert_eq!("hello world//message", right.as_str());
    /// ```
    ///
    pub fn split2(self, criteria: &str) -> Option<(Self, Self)> {
        for (i, _) in self.arr.iter().enumerate() {
            if i + criteria.len() > self.len { break; }
            if self.arr[i..i+criteria.len()] == criteria.as_bytes()[..] {
                let left = &self.arr[0..i];
                let right = &self.arr[i+criteria.len()..self.len];
                let lf: Self = left.into();
                let rg: Self = right.into();
                return Some((lf, rg))
            }
        }
        None
    }
    /// split by &str (include the criteria) and return Option<(Self, Self)>
    /// or return None if the criteria didn't match
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let b: BFRDYN<256> = "user123//hello world//message".into();
    /// let (left, right) = b.split2_incl("//").unwrap();
    ///
    /// assert_eq!("user123", left.as_str());
    /// assert_eq!("//hello world//message", right.as_str());
    /// ```
    ///
    pub fn split2_incl(self, criteria: &str) -> Option<(Self, Self)> {
        for (i, _) in self.arr.iter().enumerate() {
            if i + criteria.len() > self.len { break; }
            if self.arr[i..i+criteria.len()] == criteria.as_bytes()[..] {
                let left = &self.arr[0..i];
                let right = &self.arr[i..self.len];
                let lf: Self = left.into();
                let rg: Self = right.into();
                return Some((lf, rg))
            }
        }
        None
    }
    /// split by &str (include the criteria to the left) and return Option<(Self, Self)>
    /// or return None if the criteria didn't match
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let b: BFRDYN<256> = "user123//hello world//message".into();
    /// let (left, right) = b.split2_incl_left("//").unwrap();
    ///
    /// assert_eq!("user123//", left.as_str());
    /// assert_eq!("hello world//message", right.as_str());
    /// ```
    ///
    pub fn split2_incl_left(self, criteria: &str) -> Option<(Self, Self)> {
        for (i, _) in self.arr.iter().enumerate() {
            if i + criteria.len() > self.len { break; }
            if self.arr[i..i+criteria.len()] == criteria.as_bytes()[..] {
                let left = &self.arr[0..i+criteria.len()];
                let right = &self.arr[i+criteria.len()..self.len];
                let lf: Self = left.into();
                let rg: Self = right.into();
                return Some((lf, rg))
            }
        }
        None
    }
    /// evaluate if buffer starts_with with criteria 
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let b: BFRDYN<256> = "some text".into();
    /// let starts_with_som = b.starts_with("som");
    ///
    /// assert!(starts_with_som);
    /// ```
    ///
    pub fn starts_with(&self, criteria: &str) -> bool {
        &self.arr[0..criteria.len()] == criteria.as_bytes()
    }
    /// evaluate if buffer ends_with with criteria 
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let b: BFRDYN<256> = "some text".into();
    /// let ends_with_ext = b.ends_with("ext");
    ///
    /// assert!(ends_with_ext);
    /// ```
    ///
    pub fn ends_with(&self, criteria: &str) -> bool {
        &self.arr[self.len()-criteria.len()..self.len()] == criteria.as_bytes()
    }
    /// pop the last char from buffer
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let mut b: BFRDYN<256> = "abcd".into();
    /// let pop1 = b.pop().unwrap();
    /// let pop2 = b.pop().unwrap();
    /// let pop3 = b.pop().unwrap();
    ///
    /// assert_eq!('d', pop1);
    /// assert_eq!('c', pop2);
    /// assert_eq!('b', pop3);
    /// assert_eq!("a", b.as_str());
    /// ```
    ///
    pub fn pop(&mut self) -> Option<char> {
        if self.len > 0 {
            self.len -= 1;
            let last = self.arr[self.len];
            self.arr[self.len] = 0u8;
            return Some(last as char);
        }
        None
    }
    /// pop n char of buffer
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let mut b: BFRDYN<256> = "abcd123DEFG".into();
    /// let pop1 = b.popn(4).unwrap();
    /// let pop2 = b.popn(3).unwrap();
    /// let pop3 = b.popn(4).unwrap();
    ///
    /// assert_eq!("DEFG", pop1.as_str());
    /// assert_eq!("123", pop2.as_str());
    /// assert_eq!("abcd", pop3.as_str());
    /// assert_eq!("", b.as_str());
    /// ```
    ///
    pub fn popn(&mut self, n: usize) -> Option<Self> {
        if self.len >= n {
            self.len -= n; 
            let popped: Self = self.arr[self.len..self.len+n].into();
            let newlen = self.len;
            self.arr[newlen..].fill(0u8);
            return Some(popped);
        }
        None
    }
    /// take n char of buffer.
    /// This function is similar to pop()
    /// but take_head pop from the head instead
    /// # example
    /// ```
    /// use cbfr::cb::BFRDYN;
    ///
    /// let mut b: BFRDYN<256> = "abcd123DEFG".into();
    /// let pop1 = b.take_head(4).unwrap();
    /// let pop2 = b.take_head(3).unwrap();
    /// let pop3 = b.take_head(4).unwrap();
    ///
    /// assert_eq!("abcd", pop1.as_str());
    /// assert_eq!("123", pop2.as_str());
    /// assert_eq!("DEFG", pop3.as_str());
    /// assert_eq!("", b.as_str());
    /// ```
    ///
    pub fn take_head(&mut self, n: usize) -> Option<Self> {
        if self.len >= n {
            let popped: Self = self.arr[0..n].into();
            // shift buffer
            for _ in 0..n {
                // safety:
                // unwrap() will never throw an error
                // because self.len >= n
                self.lshift(0).unwrap();
            }
            return Some(popped);
        }
        None
    }
}