Struct ws_tool::frame::PayloadMut
source · pub struct PayloadMut<'a>(_);Expand description
a collection of mutable payload(vector of mutable u8 slice)
Implementations§
source§impl<'a> PayloadMut<'a>
impl<'a> PayloadMut<'a>
sourcepub fn len(&self) -> usize
pub fn len(&self) -> usize
return total bytes count of payloads
Examples found in repository?
src/frame.rs (line 454)
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
pub fn new<'a, P: Into<PayloadMut<'a>>>(
fin: bool,
rsv1: bool,
rsv2: bool,
rsv3: bool,
opcode: OpCode,
mask: bool,
payload: P,
) -> Self {
let mut payload: PayloadMut = payload.into();
let payload_len = payload.len();
let mut buf =
HeaderViewMut::empty_payload(fin, rsv1, rsv2, rsv3, opcode, mask, payload_len);
let start = buf.len();
let end = start + payload_len;
buf.resize(end, 0);
let mut frame = ReadFrame(buf);
let header = frame.header_mut();
if mask {
let key = header.masking_key().unwrap();
payload.apply_mask(key);
}
payload.copy_to(&mut frame.0[start..end]);
frame
}
/// construct empty payload frame
pub fn empty(opcdoe: OpCode) -> Self {
Self::new(true, false, false, false, opcdoe, true, vec![])
}
/// replace old frame with other buf and return it
pub fn replace(&mut self, other: ReadFrame) -> ReadFrame {
let frame_len = self.header().payload_idx().1;
let ret = ReadFrame(self.0.split_to(frame_len));
self.0.extend_from_slice(&other.0);
ret
}
/// readonly header view of frame
pub fn header(&self) -> HeaderView {
HeaderView(&self.0)
}
/// mutable header view of frame
pub fn header_mut(&mut self) -> HeaderViewMut {
HeaderViewMut(&mut self.0)
}
/// immutable frame payload
pub fn payload(&self) -> &[u8] {
let (start, end) = self.header().payload_idx();
&self.0[start..end]
}
/// consume frame and return (header, payload)
pub fn split(mut self) -> (Header, BytesMut) {
let stop = self.header().payload_idx().0;
let header = Header(self.0.split_to(stop));
(header, self.0)
}
/// mutable reference of payload
pub fn payload_mut(&mut self) -> &mut [u8] {
let (start, end) = self.header().payload_idx();
&mut self.0[start..end]
}
}
/// borrowed data contains payload
#[derive(Debug, Clone)]
pub struct BorrowedFrame<'a> {
pub(crate) header: Header,
/// borrowed payload
pub payload: Payload<'a>,
}
impl<'a> BorrowedFrame<'a> {
/// immutable header view
pub fn header(&self) -> HeaderView {
self.header.view()
}
/// mutable header view
pub fn header_mut(&mut self) -> HeaderViewMut {
self.header.view_mut()
}
/// payload
pub fn payload(&self) -> Payload {
self.payload.clone()
}
}
/// header for user p
#[derive(Debug, Clone)]
pub struct OwnedFrame {
header: Header,
payload: BytesMut,
}
impl OwnedFrame {
/// construct new owned frame
#[allow(clippy::too_many_arguments)]
pub fn new<M: Into<Option<[u8; 4]>>>(
fin: bool,
rsv1: bool,
rsv2: bool,
rsv3: bool,
mask_key: M,
opcode: OpCode,
mut payload: BytesMut,
mask_payload: bool,
) -> Self {
let header = Header::new(
fin,
rsv1,
rsv2,
rsv3,
mask_key,
opcode,
payload.len() as u64,
);
if mask_payload {
if let Some(key) = header.masking_key() {
apply_mask_fast32(&mut payload, key);
}
};
Self { header, payload }
}
/// immutable header view
pub fn header(&self) -> HeaderView {
self.header.view()
}
/// mutable header view
pub fn header_mut(&mut self) -> HeaderViewMut {
self.header.view_mut()
}
/// immutable payload
pub fn payload(&self) -> &[u8] {
&self.payload
}
/// mutable payload
pub fn payload_mut(&mut self) -> &mut BytesMut {
&mut self.payload
}
/// replace old payload
pub fn replace(&mut self, new: BytesMut, mask_payload: bool) -> BytesMut {
self.header_mut().set_payload_len(new.len() as u64);
let old = self.payload.split_to(self.payload.len());
self.payload = new;
if mask_payload {
if let Some(key) = self.header.masking_key() {
apply_mask_fast32(&mut self.payload, key);
}
}
old
}
}
/// a collection of immutable payload(vector of u8 slice)
#[derive(Clone, Debug)]
pub struct Payload<'a>(pub(crate) Vec<&'a [u8]>);
impl<'a> From<&'a [u8]> for Payload<'a> {
fn from(data: &'a [u8]) -> Self {
Self(vec![data])
}
}
impl<'a> From<Vec<&'a [u8]>> for Payload<'a> {
fn from(data: Vec<&'a [u8]>) -> Self {
Self(data)
}
}
impl<'a> From<&'a [&'a [u8]]> for Payload<'a> {
fn from(data: &'a [&'a [u8]]) -> Self {
Self(data.to_vec())
}
}
impl<'a> From<&'a BytesMut> for Payload<'a> {
fn from(src: &'a BytesMut) -> Self {
Self(vec![src])
}
}
impl<'a> From<&'a Bytes> for Payload<'a> {
fn from(src: &'a Bytes) -> Self {
Self(vec![src])
}
}
impl<'a> Payload<'a> {
/// check payload is empty
pub fn is_empty(&self) -> bool {
self.len() == 0
}
/// return total bytes count of payload
pub fn len(&self) -> usize {
self.0.iter().map(|i| i.len()).sum()
}
/// return payload iterator
pub fn iter(&self) -> PayloadIterator<'_> {
PayloadIterator {
payload: self,
array_idx: 0,
offset: 0,
idx: 0,
}
}
/// split payload into smaller size
pub fn split_with(&self, size: usize) -> Vec<Payload> {
let mut ret = vec![];
let last = self.0.iter().fold(vec![], |mut acc: Vec<&'a [u8]>, &arr| {
let pre_len: usize = acc.iter().map(|x| x.len()).sum();
let arr_len = arr.len();
if pre_len + arr_len <= size {
acc.push(arr);
acc
} else {
let stop = arr_len + pre_len - size;
acc.push(&arr[..stop]);
ret.push(acc.into());
vec![&arr[stop..]]
}
});
ret.push(last.into());
ret
}
/// copy all bytes in payload to dest
pub fn copy_to(&self, dest: &mut [u8]) {
let mut offset = 0;
self.0.iter().for_each(|arr| {
dest[offset..(offset + arr.len())].copy_from_slice(arr);
offset += arr.len()
})
}
/// like copy_to, but apply mask at the same time
pub fn copy_with_key(&self, dest: &mut [u8], key: [u8; 4]) {
let mut offset = 0;
self.0.iter().for_each(|arr| {
let buf: Vec<u8> = arr
.iter()
.enumerate()
.map(|(i, v)| v ^ key[(i + offset) % 4])
.collect();
dest[offset..(offset + arr.len())].copy_from_slice(&buf);
offset += arr.len()
})
}
}
/// Iterator of payload
pub struct PayloadIterator<'a> {
payload: &'a Payload<'a>,
array_idx: usize,
offset: usize,
idx: usize,
}
impl<'a> Iterator for PayloadIterator<'a> {
type Item = &'a u8;
fn next(&mut self) -> Option<Self::Item> {
self.payload.0.get(self.array_idx).and_then(|arr| {
// advance
self.idx += 1;
if self.idx >= arr.len() + self.offset {
self.array_idx += 1;
self.offset += arr.len();
}
arr.get(self.idx - self.offset)
})
}
}
/// a collection of mutable payload(vector of mutable u8 slice)
#[derive(Debug)]
pub struct PayloadMut<'a>(pub(crate) Vec<&'a mut [u8]>);
impl<'a> From<&'a mut [u8]> for PayloadMut<'a> {
fn from(data: &'a mut [u8]) -> Self {
Self(vec![data])
}
}
impl<'a> From<Vec<&'a mut [u8]>> for PayloadMut<'a> {
fn from(data: Vec<&'a mut [u8]>) -> Self {
Self(data)
}
}
impl<'a> From<&'a mut BytesMut> for PayloadMut<'a> {
fn from(src: &'a mut BytesMut) -> Self {
Self(vec![src])
}
}
impl<'a> PayloadMut<'a> {
/// check payload is empty
pub fn is_empty(&self) -> bool {
self.len() == 0
}More examples
src/codec/frame/non_blocking.rs (line 93)
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
async fn async_send_one_mut<'a, S: AsyncWrite + Unpin, M: Into<Option<[u8; 4]>>>(
&mut self,
stream: &mut S,
fin: bool,
rsv1: bool,
rsv2: bool,
rsv3: bool,
mask_key: M,
opcode: OpCode,
mut payload: PayloadMut<'a>,
mask_payload: bool,
) -> IOResult<()> {
let header = Header::new(
fin,
rsv1,
rsv2,
rsv3,
mask_key,
opcode,
payload.len() as u64,
);
if mask_payload {
if let Some(key) = header.masking_key() {
payload.apply_mask(key)
}
}
stream.write_all(&header.0).await?;
for part in payload.0 {
stream.write_all(part).await?;
}
Ok(())
}sourcepub fn split_with(self, size: usize) -> Vec<PayloadMut<'a>>
pub fn split_with(self, size: usize) -> Vec<PayloadMut<'a>>
split payload into smaller size
Examples found in repository?
src/codec/frame/non_blocking.rs (line 129)
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
pub async fn async_send_mut<'a, S: AsyncWrite + Unpin>(
&mut self,
stream: &mut S,
opcode: OpCode,
payload: PayloadMut<'a>,
mask_payload: bool,
) -> IOResult<()> {
let split_size = self.config.auto_fragment_size;
let mask_send = self.config.mask_send_frame;
let mask_fn = || {
if mask_send {
Some(rand::random())
} else {
None
}
};
if split_size > 0 {
let parts = payload.split_with(split_size);
let total = parts.len();
for (idx, part) in parts.into_iter().enumerate() {
let fin = idx + 1 == total;
let key = mask_fn();
self.async_send_one_mut(
stream,
fin,
false,
false,
false,
key,
opcode.clone(),
part,
mask_payload,
)
.await?;
}
} else {
let key = mask_fn();
self.async_send_one_mut(
stream,
true,
false,
false,
false,
key,
opcode,
payload,
mask_payload,
)
.await?;
}
Ok(())
}sourcepub fn copy_to(&self, dest: &mut [u8])
pub fn copy_to(&self, dest: &mut [u8])
copy all bytes in payload to dest
Examples found in repository?
src/frame.rs (line 466)
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
pub fn new<'a, P: Into<PayloadMut<'a>>>(
fin: bool,
rsv1: bool,
rsv2: bool,
rsv3: bool,
opcode: OpCode,
mask: bool,
payload: P,
) -> Self {
let mut payload: PayloadMut = payload.into();
let payload_len = payload.len();
let mut buf =
HeaderViewMut::empty_payload(fin, rsv1, rsv2, rsv3, opcode, mask, payload_len);
let start = buf.len();
let end = start + payload_len;
buf.resize(end, 0);
let mut frame = ReadFrame(buf);
let header = frame.header_mut();
if mask {
let key = header.masking_key().unwrap();
payload.apply_mask(key);
}
payload.copy_to(&mut frame.0[start..end]);
frame
}sourcepub fn apply_mask(&mut self, mask: [u8; 4])
pub fn apply_mask(&mut self, mask: [u8; 4])
apply mask by the given mask key
Examples found in repository?
src/frame.rs (line 464)
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
pub fn new<'a, P: Into<PayloadMut<'a>>>(
fin: bool,
rsv1: bool,
rsv2: bool,
rsv3: bool,
opcode: OpCode,
mask: bool,
payload: P,
) -> Self {
let mut payload: PayloadMut = payload.into();
let payload_len = payload.len();
let mut buf =
HeaderViewMut::empty_payload(fin, rsv1, rsv2, rsv3, opcode, mask, payload_len);
let start = buf.len();
let end = start + payload_len;
buf.resize(end, 0);
let mut frame = ReadFrame(buf);
let header = frame.header_mut();
if mask {
let key = header.masking_key().unwrap();
payload.apply_mask(key);
}
payload.copy_to(&mut frame.0[start..end]);
frame
}More examples
src/codec/frame/non_blocking.rs (line 97)
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
async fn async_send_one_mut<'a, S: AsyncWrite + Unpin, M: Into<Option<[u8; 4]>>>(
&mut self,
stream: &mut S,
fin: bool,
rsv1: bool,
rsv2: bool,
rsv3: bool,
mask_key: M,
opcode: OpCode,
mut payload: PayloadMut<'a>,
mask_payload: bool,
) -> IOResult<()> {
let header = Header::new(
fin,
rsv1,
rsv2,
rsv3,
mask_key,
opcode,
payload.len() as u64,
);
if mask_payload {
if let Some(key) = header.masking_key() {
payload.apply_mask(key)
}
}
stream.write_all(&header.0).await?;
for part in payload.0 {
stream.write_all(part).await?;
}
Ok(())
}