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
//! A view into a sequence of values in memory.
use crate::{
core::{
def::NSTDErrorCode,
mem::nstd_core_mem_copy,
ptr::{
nstd_core_ptr_get, nstd_core_ptr_mut_get, nstd_core_ptr_mut_get_const,
nstd_core_ptr_mut_new, nstd_core_ptr_mut_size, nstd_core_ptr_new, nstd_core_ptr_size,
NSTDPtr, NSTDPtrMut,
},
},
NSTDAny, NSTDAnyMut, NSTDUInt, NSTD_NULL,
};
/// An immutable view into a sequence of values in memory.
///
/// # Safety
///
/// The user of this structure must ensure that the pointed-to data remains valid and unmodified
/// while an instance of this structure is in use.
#[repr(C)]
#[derive(Clone, Copy, Debug, Hash)]
pub struct NSTDSlice {
/// A pointer to the first element in the slice.
ptr: NSTDPtr,
/// The number of elements in the slice.
len: NSTDUInt,
}
impl NSTDSlice {
/// Returns the number of bytes that this slice covers.
#[inline]
pub(crate) fn byte_len(&self) -> usize {
self.len * nstd_core_slice_stride(self)
}
/// Creates a Rust byte slice from this `NSTDSlice`.
///
/// # Panics
///
/// This operation will panic in the following situations:
///
/// - `size_of::<T>()` does not match the slice's stride.
///
/// - The number of bytes the slice contains is greater than `NSTDInt`'s maximum value.
///
/// # Safety
///
/// - The `NSTDSlice`'s data must remain valid and unmodified while the returned slice is in
/// use.
///
/// - The slice's data must be properly aligned.
#[inline]
pub(crate) unsafe fn as_slice<T>(&self) -> &[T] {
assert!(nstd_core_slice_stride(self) == core::mem::size_of::<T>());
assert!(self.byte_len() <= isize::MAX as usize);
let ptr = nstd_core_slice_as_ptr(self).cast();
core::slice::from_raw_parts(ptr, self.len)
}
}
/// Creates a new slice from raw data.
///
/// # Parameters:
///
/// - `NSTDAny ptr` - A pointer to the first element in the sequence.
///
/// - `NSTDUInt element_size` - The number of bytes each element occupies.
///
/// - `NSTDUInt len` - The number of elements in the sequence.
///
/// # Returns
///
/// `NSTDSlice slice` - The new slice.
#[inline]
#[cfg_attr(feature = "clib", no_mangle)]
pub extern "C" fn nstd_core_slice_new(
ptr: NSTDAny,
element_size: NSTDUInt,
len: NSTDUInt,
) -> NSTDSlice {
NSTDSlice {
ptr: nstd_core_ptr_new(ptr, element_size),
len,
}
}
/// Returns a raw pointer to the slice's memory.
///
/// # Parameters:
///
/// - `const NSTDSlice *slice` - The slice.
///
/// # Returns
///
/// `AnyConst ptr` - A raw pointer to the slice's memory.
///
/// # Example
///
/// ```
/// use nstd_sys::core::slice::{nstd_core_slice_as_ptr, nstd_core_slice_new};
///
/// let bytes = "Hello, world!".as_bytes();
/// let bytes_ptr = bytes.as_ptr().cast();
/// let slice = nstd_core_slice_new(bytes_ptr, 1, bytes.len());
/// assert!(nstd_core_slice_as_ptr(&slice) == bytes_ptr);
/// ```
#[inline]
#[cfg_attr(feature = "clib", no_mangle)]
pub extern "C" fn nstd_core_slice_as_ptr(slice: &NSTDSlice) -> NSTDAny {
nstd_core_ptr_get(&slice.ptr)
}
/// Returns the number of elements in an immutable slice.
///
/// # Parameters:
///
/// - `const NSTDSlice *slice` - The immutable slice.
///
/// # Returns
///
/// `NSTDUInt len` - The length of the slice.
///
/// # Example
///
/// ```
/// use nstd_sys::core::slice::{nstd_core_slice_len, nstd_core_slice_new};
///
/// let bytes = "Goodbye, world!".as_bytes();
/// let len = bytes.len();
/// let slice = nstd_core_slice_new(bytes.as_ptr().cast(), 1, len);
/// assert!(nstd_core_slice_len(&slice) == len);
/// ```
#[inline]
#[cfg_attr(feature = "clib", no_mangle)]
pub extern "C" fn nstd_core_slice_len(slice: &NSTDSlice) -> NSTDUInt {
slice.len
}
/// Returns the amount of bytes each value in a slice occupies.
///
/// # Parameters:
///
/// - `const NSTDSlice *slice` - The slice.
///
/// # Returns
///
/// `NSTDUInt stride` - The size of each value in the slice.
///
/// # Example
///
/// ```
/// use nstd_sys::core::slice::{nstd_core_slice_stride, nstd_core_slice_new};
///
/// let bytes = "Hello, world!".as_bytes();
/// let slice = nstd_core_slice_new(bytes.as_ptr().cast(), 1, bytes.len());
/// assert!(nstd_core_slice_stride(&slice) == 1);
/// ```
#[inline]
#[cfg_attr(feature = "clib", no_mangle)]
pub extern "C" fn nstd_core_slice_stride(slice: &NSTDSlice) -> NSTDUInt {
nstd_core_ptr_size(&slice.ptr)
}
/// Returns an immutable pointer to the element at index `pos` in `slice`.
///
/// # Parameters:
///
/// - `const NSTDSlice *slice` - The slice to read an element from.
///
/// - `NSTDUInt pos` - The position of the element to get, starting at 0.
///
/// # Returns
///
/// `NSTDAny element` - A pointer to the element at `pos` or `NSTD_NULL` if `pos` is out
/// of the slice's boundaries.
///
/// # Panics
///
/// Panics if the slice's current length in bytes exceeds `NSTDInt`'s max value.
///
/// # Example
///
/// ```
/// use nstd_sys::core::slice::{nstd_core_slice_get, nstd_core_slice_new};
///
/// const STRIDE: usize = core::mem::size_of::<i32>();
///
/// let numbers: [i32; 3] = [33, 103, 45];
/// let slice = nstd_core_slice_new(numbers.as_ptr().cast(), STRIDE, numbers.len());
///
/// unsafe {
/// assert!(*nstd_core_slice_get(&slice, 0).cast::<i32>() == 33);
/// assert!(*nstd_core_slice_get(&slice, 1).cast::<i32>() == 103);
/// assert!(*nstd_core_slice_get(&slice, 2).cast::<i32>() == 45);
/// assert!(nstd_core_slice_get(&slice, 3).is_null());
/// }
/// ```
#[inline]
#[cfg_attr(feature = "clib", no_mangle)]
pub extern "C" fn nstd_core_slice_get(slice: &NSTDSlice, mut pos: NSTDUInt) -> NSTDAny {
if pos < slice.len {
pos *= nstd_core_slice_stride(slice);
assert!(pos <= isize::MAX as usize);
// SAFETY: We've checked `pos`.
return unsafe { nstd_core_slice_as_ptr(slice).add(pos) };
}
NSTD_NULL
}
/// Returns an immutable pointer to the first element in the slice.
///
/// # Parameters:
///
/// - `const NSTDSlice *slice` - The slice to get the first element of.
///
/// # Returns
///
/// `NSTDAny element` - A pointer to the first element in `slice` or `NSTD_NULL` if the
/// slice is empty.
///
/// # Example
///
/// ```
/// use nstd_sys::core::slice::{nstd_core_slice_first, nstd_core_slice_new};
///
/// const STRIDE: usize = core::mem::size_of::<u64>();
///
/// let numbers: [u64; 3] = [707, 23043, 8008];
/// let numbers_ptr = numbers.as_ptr().cast();
/// let slice = nstd_core_slice_new(numbers_ptr, STRIDE, numbers.len());
/// let empty = nstd_core_slice_new(numbers_ptr, STRIDE, 0);
///
/// unsafe {
/// assert!(nstd_core_slice_first(&slice) == numbers_ptr);
/// assert!(*nstd_core_slice_first(&slice).cast::<u64>() == 707);
/// assert!(nstd_core_slice_first(&empty).is_null());
/// }
/// ```
#[inline]
#[cfg_attr(feature = "clib", no_mangle)]
pub extern "C" fn nstd_core_slice_first(slice: &NSTDSlice) -> NSTDAny {
match slice.len > 0 {
true => nstd_core_slice_as_ptr(slice),
false => NSTD_NULL,
}
}
/// Returns an immutable pointer to the last element in the slice.
///
/// # Parameters:
///
/// - `const NSTDSlice *slice` - The slice to get the last element of.
///
/// # Returns
///
/// `NSTDAny element` - A pointer to the last element in `slice` or `NSTD_NULL` if the
/// slice is empty.
///
/// # Panics
///
/// Panics if the slice's current length in bytes exceeds `NSTDInt`'s max value.
///
/// # Example
///
/// ```
/// use nstd_sys::core::slice::{nstd_core_slice_last, nstd_core_slice_new};
///
/// const STRIDE: usize = core::mem::size_of::<u64>();
///
/// let numbers: [u64; 3] = [717, 421, 4317];
/// let numbers_ptr = numbers.as_ptr().cast();
/// let slice = nstd_core_slice_new(numbers_ptr, STRIDE, numbers.len());
/// let empty = nstd_core_slice_new(numbers_ptr, STRIDE, 0);
///
/// unsafe {
/// assert!(*nstd_core_slice_last(&slice).cast::<u64>() == 4317);
/// assert!(nstd_core_slice_last(&empty).is_null());
/// }
/// ```
#[inline]
#[cfg_attr(feature = "clib", no_mangle)]
pub extern "C" fn nstd_core_slice_last(slice: &NSTDSlice) -> NSTDAny {
match slice.len > 0 {
true => nstd_core_slice_get(slice, slice.len - 1),
false => NSTD_NULL,
}
}
/// A view into a sequence of values in memory.
///
/// # Safety
///
/// The user of this structure must ensure that the pointed-to data remains valid, unmodified, and
/// unreferenced in any other code while an instance of this structure is in use, else data races
/// may occur.
#[repr(C)]
#[derive(Clone, Copy, Debug, Hash)]
pub struct NSTDSliceMut {
/// A pointer to the first element in the slice.
ptr: NSTDPtrMut,
/// The number of elements in the slice.
len: NSTDUInt,
}
impl NSTDSliceMut {
/// Returns the number of bytes that this slice covers.
#[inline]
pub(crate) fn byte_len(&self) -> usize {
self.len * nstd_core_slice_mut_stride(self)
}
/// Creates a Rust byte slice from this `NSTDSliceMut`.
///
/// # Panics
///
/// This operation will panic in the following situations:
///
/// - `size_of::<T>()` does not match the slice's stride.
///
/// - The number of bytes the slice contains is greater than `NSTDInt`'s maximum value.
///
/// # Safety
///
/// - The `NSTDSliceMut`'s data must remain valid and unmodified while the returned slice is in
/// use.
///
/// - The slice's data must be properly aligned.
#[inline]
pub(crate) unsafe fn as_slice<T>(&self) -> &[T] {
assert!(nstd_core_slice_mut_stride(self) == core::mem::size_of::<T>());
assert!(self.byte_len() <= isize::MAX as usize);
let ptr = nstd_core_slice_mut_as_ptr_const(self).cast();
core::slice::from_raw_parts(ptr, self.len)
}
/// Creates a mutable Rust byte slice from this `NSTDSliceMut`.
///
/// # Panics
///
/// This operation will panic in the following situations:
///
/// - `size_of::<T>()` does not match the slice's stride.
///
/// - The number of bytes the slice contains is greater than `NSTDInt`'s maximum value.
///
/// # Safety
///
/// - The `NSTDSliceMut`'s data must remain valid and unmodified while the returned slice is in
/// use.
///
/// - The slice's data must be properly aligned.
#[inline]
#[allow(dead_code)]
pub(crate) unsafe fn as_slice_mut<T>(&mut self) -> &mut [T] {
assert!(nstd_core_slice_mut_stride(self) == core::mem::size_of::<T>());
assert!(self.byte_len() <= isize::MAX as usize);
let ptr = nstd_core_slice_mut_as_ptr(self).cast();
core::slice::from_raw_parts_mut(ptr, self.len)
}
}
/// Creates a new slice from raw data.
///
/// # Parameters:
///
/// - `NSTDAnyMut ptr` - A pointer to the first element in the sequence.
///
/// - `NSTDUInt element_size` - The number of bytes each element occupies.
///
/// - `NSTDUInt len` - The number of elements in the sequence.
///
/// # Returns
///
/// `NSTDSliceMut slice` - The new slice.
#[inline]
#[cfg_attr(feature = "clib", no_mangle)]
pub extern "C" fn nstd_core_slice_mut_new(
ptr: NSTDAnyMut,
element_size: NSTDUInt,
len: NSTDUInt,
) -> NSTDSliceMut {
NSTDSliceMut {
ptr: nstd_core_ptr_mut_new(ptr, element_size),
len,
}
}
/// Creates an immutable version of a mutable slice.
///
/// # Parameters:
///
/// - `const NSTDSliceMut *slice` - The mutable slice.
///
/// # Returns
///
/// `NSTDSlice slice_const` - The immutable copy of `slice`.
#[inline]
#[cfg_attr(feature = "clib", no_mangle)]
pub extern "C" fn nstd_core_slice_mut_as_const(slice: &NSTDSliceMut) -> NSTDSlice {
let ptr = nstd_core_slice_mut_as_ptr_const(slice);
let stride = nstd_core_slice_mut_stride(slice);
nstd_core_slice_new(ptr, stride, slice.len)
}
/// Returns a raw pointer to the slice's memory.
///
/// # Parameters:
///
/// - `NSTDSliceMut *slice` - The slice.
///
/// # Returns
///
/// `NSTDAnyMut ptr` - A raw pointer to the slice's memory.
///
/// # Example
///
/// ```
/// use nstd_sys::core::slice::{
/// nstd_core_slice_mut_as_ptr, nstd_core_slice_mut_get_const, nstd_core_slice_mut_new,
/// };
///
/// const STRIDE: usize = core::mem::size_of::<u16>();
///
/// let mut buf: [u16; 3] = [3, 5, 7];
/// let mut slice = nstd_core_slice_mut_new(buf.as_mut_ptr().cast(), STRIDE, buf.len());
///
/// unsafe {
/// *nstd_core_slice_mut_as_ptr(&mut slice).cast::<u16>() = 1;
/// assert!(*nstd_core_slice_mut_get_const(&slice, 0).cast::<u16>() == 1);
/// }
/// ```
#[inline]
#[cfg_attr(feature = "clib", no_mangle)]
pub extern "C" fn nstd_core_slice_mut_as_ptr(slice: &mut NSTDSliceMut) -> NSTDAnyMut {
nstd_core_ptr_mut_get(&mut slice.ptr)
}
/// Returns an immutable raw pointer to the slice's memory.
///
/// # Parameters:
///
/// - `const NSTDSliceMut *slice` - The slice.
///
/// # Returns
///
/// `NSTDAny ptr` - A raw pointer to the slice's memory.
///
/// # Example
///
/// ```
/// use nstd_sys::core::slice::{nstd_core_slice_mut_as_ptr_const, nstd_core_slice_mut_new};
///
/// let mut m33 = String::from("33marrow");
/// let raw_ptr = m33.as_mut_ptr().cast();
/// let slice = nstd_core_slice_mut_new(raw_ptr, 1, m33.len());
/// assert!(nstd_core_slice_mut_as_ptr_const(&slice) == raw_ptr);
/// ```
#[inline]
#[cfg_attr(feature = "clib", no_mangle)]
pub extern "C" fn nstd_core_slice_mut_as_ptr_const(slice: &NSTDSliceMut) -> NSTDAny {
nstd_core_ptr_mut_get_const(&slice.ptr)
}
/// Returns the number of elements in a slice.
///
/// # Parameters:
///
/// - `const NSTDSliceMut *slice` - The slice.
///
/// # Returns
///
/// `NSTDUInt len` - The length of the slice.
///
/// # Example
///
/// ```
/// use nstd_sys::core::slice::{nstd_core_slice_mut_len, nstd_core_slice_mut_new};
///
/// let mut bye = String::from("Goodbye, cruel world!");
/// let len = bye.len();
/// let slice = nstd_core_slice_mut_new(bye.as_mut_ptr().cast(), 1, len);
/// assert!(nstd_core_slice_mut_len(&slice) == len);
/// ```
#[inline]
#[cfg_attr(feature = "clib", no_mangle)]
pub extern "C" fn nstd_core_slice_mut_len(slice: &NSTDSliceMut) -> NSTDUInt {
slice.len
}
/// Returns the amount of bytes each value in a slice occupies.
///
/// # Parameters:
///
/// - `const NSTDSliceMut *slice` - The slice.
///
/// # Returns
///
/// `NSTDUInt stride` - The size of each value in the slice.
///
/// # Example
///
/// ```
/// use nstd_sys::core::slice::{nstd_core_slice_mut_stride, nstd_core_slice_mut_new};
///
/// let mut hw = String::from("Hello, world!");
/// let slice = nstd_core_slice_mut_new(hw.as_mut_ptr().cast(), 1, hw.len());
/// assert!(nstd_core_slice_mut_stride(&slice) == 1);
/// ```
#[inline]
#[cfg_attr(feature = "clib", no_mangle)]
pub extern "C" fn nstd_core_slice_mut_stride(slice: &NSTDSliceMut) -> NSTDUInt {
nstd_core_ptr_mut_size(&slice.ptr)
}
/// Returns a pointer to the element at index `pos` in `slice`.
///
/// # Parameters:
///
/// - `NSTDSliceMut *slice` - The slice to read an element from.
///
/// - `NSTDUInt pos` - The position of the element to get, starting at 0.
///
/// # Returns
///
/// `NSTDAnyMut element` - A pointer to the element at `pos` or `NSTD_NULL` if `pos` is out of
/// the slice's boundaries.
///
/// # Panics
///
/// Panics if the slice's current length in bytes exceeds `NSTDInt`'s max value.
///
/// # Example
///
/// ```
/// use nstd_sys::core::slice::{nstd_core_slice_mut_get, nstd_core_slice_mut_new};
///
/// const STRIDE: usize = core::mem::size_of::<i32>();
///
/// let mut numbers = [0i32; 3];
/// let mut slice = nstd_core_slice_mut_new(numbers.as_mut_ptr().cast(), STRIDE, numbers.len());
///
/// unsafe {
/// *nstd_core_slice_mut_get(&mut slice, 0).cast::<i32>() = 33;
/// *nstd_core_slice_mut_get(&mut slice, 1).cast::<i32>() = 103;
/// *nstd_core_slice_mut_get(&mut slice, 2).cast::<i32>() = 45;
/// assert!(numbers == [33, 103, 45]);
/// }
/// ```
#[inline]
#[cfg_attr(feature = "clib", no_mangle)]
pub extern "C" fn nstd_core_slice_mut_get(slice: &mut NSTDSliceMut, pos: NSTDUInt) -> NSTDAnyMut {
nstd_core_slice_mut_get_const(slice, pos) as NSTDAnyMut
}
/// Returns an immutable pointer to the element at index `pos` in `slice`.
///
/// # Parameters:
///
/// - `const NSTDSliceMut *slice` - The slice to read an element from.
///
/// - `NSTDUInt pos` - The position of the element to get, starting at 0.
///
/// # Returns
///
/// `NSTDAny element` - A pointer to the element at `pos` or `NSTD_NULL` if `pos` is out
/// of the slice's boundaries.
///
/// # Panics
///
/// Panics if the slice's current length in bytes exceeds `NSTDInt`'s max value.
///
/// # Example
///
/// ```
/// use nstd_sys::core::slice::{nstd_core_slice_mut_get_const, nstd_core_slice_mut_new};
///
/// const STRIDE: usize = core::mem::size_of::<i32>();
///
/// let mut numbers: [i32; 3] = [33, 103, 45];
/// let slice = nstd_core_slice_mut_new(numbers.as_mut_ptr().cast(), STRIDE, numbers.len());
///
/// unsafe {
/// assert!(*nstd_core_slice_mut_get_const(&slice, 0).cast::<i32>() == 33);
/// assert!(*nstd_core_slice_mut_get_const(&slice, 1).cast::<i32>() == 103);
/// assert!(*nstd_core_slice_mut_get_const(&slice, 2).cast::<i32>() == 45);
/// assert!(nstd_core_slice_mut_get_const(&slice, 3).is_null());
/// }
/// ```
#[inline]
#[cfg_attr(feature = "clib", no_mangle)]
pub extern "C" fn nstd_core_slice_mut_get_const(
slice: &NSTDSliceMut,
mut pos: NSTDUInt,
) -> NSTDAny {
if pos < slice.len {
pos *= nstd_core_slice_mut_stride(slice);
assert!(pos <= isize::MAX as usize);
// SAFETY: We've checked `pos`.
return unsafe { nstd_core_slice_mut_as_ptr_const(slice).add(pos) };
}
NSTD_NULL
}
/// Returns a pointer to the first element in the slice.
///
/// # Parameters:
///
/// - `NSTDSliceMut *slice` - The slice to get the first element of.
///
/// # Returns
///
/// `NSTDAnyMut element` - A pointer to the first element in `slice` or `NSTD_NULL` if the slice
/// is empty.
///
/// # Example
///
/// ```
/// use nstd_sys::core::slice::{nstd_core_slice_mut_first, nstd_core_slice_mut_new};
///
/// const STRIDE: usize = core::mem::size_of::<u64>();
///
/// let mut numbers: [u64; 3] = [707, 23043, 8008];
/// let mut slice = nstd_core_slice_mut_new(numbers.as_mut_ptr().cast(), STRIDE, numbers.len());
///
/// unsafe { *nstd_core_slice_mut_first(&mut slice).cast::<u64>() = 101 };
/// assert!(numbers[0] == 101);
/// ```
#[inline]
#[cfg_attr(feature = "clib", no_mangle)]
pub extern "C" fn nstd_core_slice_mut_first(slice: &mut NSTDSliceMut) -> NSTDAnyMut {
nstd_core_slice_mut_first_const(slice) as NSTDAnyMut
}
/// Returns an immutable pointer to the first element in the slice.
///
/// # Parameters:
///
/// - `const NSTDSliceMut *slice` - The slice to get the first element of.
///
/// # Returns
///
/// `NSTDAny element` - A pointer to the first element in `slice` or `NSTD_NULL` if the
/// slice is empty.
///
/// # Example
///
/// ```
/// use nstd_sys::core::slice::{nstd_core_slice_mut_first_const, nstd_core_slice_mut_new};
///
/// const STRIDE: usize = core::mem::size_of::<u64>();
///
/// let mut numbers: [u64; 3] = [707, 23043, 8008];
/// let numbers_ptr = numbers.as_mut_ptr().cast();
/// let slice = nstd_core_slice_mut_new(numbers_ptr, STRIDE, numbers.len());
/// let empty = nstd_core_slice_mut_new(numbers_ptr, STRIDE, 0);
///
/// unsafe {
/// assert!(nstd_core_slice_mut_first_const(&slice) == numbers_ptr);
/// assert!(*nstd_core_slice_mut_first_const(&slice).cast::<u64>() == 707);
/// assert!(nstd_core_slice_mut_first_const(&empty).is_null());
/// }
/// ```
#[inline]
#[cfg_attr(feature = "clib", no_mangle)]
pub extern "C" fn nstd_core_slice_mut_first_const(slice: &NSTDSliceMut) -> NSTDAny {
match slice.len > 0 {
true => nstd_core_slice_mut_as_ptr_const(slice),
false => NSTD_NULL,
}
}
/// Returns a pointer to the last element in the slice.
///
/// # Parameters:
///
/// - `NSTDSliceMut *slice` - The slice to get the last element of.
///
/// # Returns
///
/// `NSTDAnyMut element` - A pointer to the last element in `slice` or `NSTD_NULL` if the slice
/// is empty.
///
/// # Panics
///
/// Panics if the slice's current length in bytes exceeds `NSTDInt`'s max value.
///
/// # Example
///
/// ```
/// use nstd_sys::core::slice::{nstd_core_slice_mut_last, nstd_core_slice_mut_new};
///
/// const STRIDE: usize = core::mem::size_of::<u64>();
///
/// let mut numbers: [u64; 3] = [717, 421, 4317];
/// let mut slice = nstd_core_slice_mut_new(numbers.as_mut_ptr().cast(), STRIDE, numbers.len());
///
/// unsafe { *nstd_core_slice_mut_last(&mut slice).cast::<u64>() = 1738 };
/// assert!(numbers[2] == 1738);
/// ```
#[inline]
#[cfg_attr(feature = "clib", no_mangle)]
pub extern "C" fn nstd_core_slice_mut_last(slice: &mut NSTDSliceMut) -> NSTDAnyMut {
nstd_core_slice_mut_last_const(slice) as NSTDAnyMut
}
/// Returns an immutable pointer to the last element in the slice.
///
/// # Parameters:
///
/// - `const NSTDSliceMut *slice` - The slice to get the last element of.
///
/// # Returns
///
/// `NSTDAny element` - A pointer to the last element in `slice` or `NSTD_NULL` if the
/// slice is empty.
///
/// # Panics
///
/// Panics if the slice's current length in bytes exceeds `NSTDInt`'s max value.
///
/// # Example
///
/// ```
/// use nstd_sys::core::slice::{nstd_core_slice_mut_last_const, nstd_core_slice_mut_new};
///
/// const STRIDE: usize = core::mem::size_of::<u64>();
///
/// let mut numbers: [u64; 3] = [717, 421, 4317];
/// let numbers_ptr = numbers.as_mut_ptr().cast();
/// let slice = nstd_core_slice_mut_new(numbers_ptr, STRIDE, numbers.len());
/// let empty = nstd_core_slice_mut_new(numbers_ptr, STRIDE, 0);
///
/// unsafe {
/// assert!(*nstd_core_slice_mut_last_const(&slice).cast::<u64>() == 4317);
/// assert!(nstd_core_slice_mut_last_const(&empty).is_null());
/// }
/// ```
#[inline]
#[cfg_attr(feature = "clib", no_mangle)]
pub extern "C" fn nstd_core_slice_mut_last_const(slice: &NSTDSliceMut) -> NSTDAny {
match slice.len > 0 {
true => nstd_core_slice_mut_get_const(slice, slice.len - 1),
false => NSTD_NULL,
}
}
/// Copies data into `dest` from `src`. The number of bytes copied is determined by `src`.
///
/// # Parameters:
///
/// - `NSTDSliceMut *dest` - The slice to copy data to.
///
/// - `const NSTDSlice *src` - The slice to copy data from.
///
/// # Returns
///
/// `NSTDErrorCode errc` - Nonzero on error.
///
/// # Possible errors
///
/// - `1` - The two buffer's lengths do not match.
///
/// - `2` - The two buffer's strides do not match.
///
/// # Safety
///
/// This function can cause undefined behavior if either `dest` or `src`'s data is invalid.
///
/// # Example
///
/// ```
/// use nstd_sys::core::slice::{
/// nstd_core_slice_mut_copy, nstd_core_slice_mut_new, nstd_core_slice_new,
/// };
///
/// const STRIDE: usize = core::mem::size_of::<u32>();
///
/// let mut dest_arr = [0u32; 5];
/// let src_arr: [u32; 5] = [7, 43, 32, 90, 15];
///
/// let mut dest = nstd_core_slice_mut_new(dest_arr.as_mut_ptr().cast(), STRIDE, dest_arr.len());
/// let src = nstd_core_slice_new(src_arr.as_ptr().cast(), STRIDE, src_arr.len());
///
/// unsafe { nstd_core_slice_mut_copy(&mut dest, &src) };
/// assert!(dest_arr == src_arr);
/// ```
#[cfg_attr(feature = "clib", no_mangle)]
pub unsafe extern "C" fn nstd_core_slice_mut_copy(
dest: &mut NSTDSliceMut,
src: &NSTDSlice,
) -> NSTDErrorCode {
if dest.len != src.len {
1
} else if nstd_core_slice_mut_stride(dest) != nstd_core_slice_stride(src) {
2
} else {
let len = src.byte_len();
let dest = nstd_core_slice_mut_as_ptr(dest).cast();
let src = nstd_core_slice_as_ptr(src).cast();
nstd_core_mem_copy(dest, src, len);
0
}
}