Struct ws_tool::frame::HeaderView
source · pub struct HeaderView<'a>(_);Expand description
frame header
Implementations§
source§impl<'a> HeaderView<'a>
impl<'a> HeaderView<'a>
sourcepub fn fin(&self) -> bool
pub fn fin(&self) -> bool
get fin bit value
Examples found in repository?
src/codec/frame/mod.rs (line 242)
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
pub fn check_frame(&mut self, unmasked_frame: ReadFrame) -> Result<Option<ReadFrame>, WsError> {
let header = unmasked_frame.header();
let opcode = header.opcode();
match opcode {
OpCode::Continue => {
if !self.fragmented {
return Err(WsError::ProtocolError {
close_code: 1002,
error: ProtocolError::MissInitialFragmentedFrame,
});
}
let (header_len, _) = header.payload_idx();
let fin = header.fin();
let mut buf = unmasked_frame.0;
buf.advance(header_len);
self.fragmented_data.0.unsplit(buf);
if fin {
// if String::from_utf8(fragmented_data.to_vec()).is_err() {
// return Err(WsError::ProtocolError {
// close_code: 1007,
// error: ProtocolError::InvalidUtf8,
// });
// }
let completed_frame = self
.fragmented_data
.replace(ReadFrame::empty(OpCode::Binary));
Ok(Some(completed_frame))
} else {
Ok(None)
}
}
OpCode::Text | OpCode::Binary => {
if self.fragmented {
return Err(WsError::ProtocolError {
close_code: 1002,
error: ProtocolError::NotContinueFrameAfterFragmented,
});
}
if !header.fin() {
self.fragmented = true;
self.fragmented_type = opcode.clone();
self.fragmented_data.header_mut().set_opcode(opcode);
let header_len = header.payload_idx().0;
let mut buf = unmasked_frame.0;
buf.advance(header_len);
self.fragmented_data.0.unsplit(buf);
Ok(None)
} else {
// if opcode == OpCode::Text
// && String::from_utf8(frame.payload_data_unmask().to_vec()).is_err()
// {
// return Err(WsError::ProtocolError {
// close_code: 1007,
// error: ProtocolError::InvalidUtf8,
// });
// }
Ok(Some(unmasked_frame))
}
}
OpCode::Close | OpCode::Ping | OpCode::Pong => {
if !header.fin() {
return Err(WsError::ProtocolError {
close_code: 1002,
error: ProtocolError::FragmentedControlFrame,
});
}
let payload_len = header.payload_len();
if payload_len > 125 {
let error = ProtocolError::ControlFrameTooBig(payload_len as usize);
return Err(WsError::ProtocolError {
close_code: 1002,
error,
});
}
if opcode == OpCode::Close {
if payload_len == 1 {
let error = ProtocolError::InvalidCloseFramePayload;
return Err(WsError::ProtocolError {
close_code: 1002,
error,
});
}
if payload_len >= 2 {
let payload = unmasked_frame.payload();
// check close code
let mut code_byte = [0u8; 2];
code_byte.copy_from_slice(&payload[..2]);
let code = u16::from_be_bytes(code_byte);
if code < 1000
|| (1004..=1006).contains(&code)
|| (1015..=2999).contains(&code)
|| code >= 5000
{
let error = ProtocolError::InvalidCloseCode(code);
return Err(WsError::ProtocolError {
close_code: 1002,
error,
});
}
// utf-8 validation
if String::from_utf8(payload[2..].to_vec()).is_err() {
let error = ProtocolError::InvalidUtf8;
return Err(WsError::ProtocolError {
close_code: 1007,
error,
});
}
}
}
Ok(Some(unmasked_frame))
}
OpCode::ReservedNonControl | OpCode::ReservedControl => {
Err(WsError::UnsupportedFrame(opcode))
}
}
}sourcepub fn opcode(&self) -> OpCode
pub fn opcode(&self) -> OpCode
return frame opcode
Examples found in repository?
More examples
src/codec/frame/mod.rs (line 232)
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
pub fn check_frame(&mut self, unmasked_frame: ReadFrame) -> Result<Option<ReadFrame>, WsError> {
let header = unmasked_frame.header();
let opcode = header.opcode();
match opcode {
OpCode::Continue => {
if !self.fragmented {
return Err(WsError::ProtocolError {
close_code: 1002,
error: ProtocolError::MissInitialFragmentedFrame,
});
}
let (header_len, _) = header.payload_idx();
let fin = header.fin();
let mut buf = unmasked_frame.0;
buf.advance(header_len);
self.fragmented_data.0.unsplit(buf);
if fin {
// if String::from_utf8(fragmented_data.to_vec()).is_err() {
// return Err(WsError::ProtocolError {
// close_code: 1007,
// error: ProtocolError::InvalidUtf8,
// });
// }
let completed_frame = self
.fragmented_data
.replace(ReadFrame::empty(OpCode::Binary));
Ok(Some(completed_frame))
} else {
Ok(None)
}
}
OpCode::Text | OpCode::Binary => {
if self.fragmented {
return Err(WsError::ProtocolError {
close_code: 1002,
error: ProtocolError::NotContinueFrameAfterFragmented,
});
}
if !header.fin() {
self.fragmented = true;
self.fragmented_type = opcode.clone();
self.fragmented_data.header_mut().set_opcode(opcode);
let header_len = header.payload_idx().0;
let mut buf = unmasked_frame.0;
buf.advance(header_len);
self.fragmented_data.0.unsplit(buf);
Ok(None)
} else {
// if opcode == OpCode::Text
// && String::from_utf8(frame.payload_data_unmask().to_vec()).is_err()
// {
// return Err(WsError::ProtocolError {
// close_code: 1007,
// error: ProtocolError::InvalidUtf8,
// });
// }
Ok(Some(unmasked_frame))
}
}
OpCode::Close | OpCode::Ping | OpCode::Pong => {
if !header.fin() {
return Err(WsError::ProtocolError {
close_code: 1002,
error: ProtocolError::FragmentedControlFrame,
});
}
let payload_len = header.payload_len();
if payload_len > 125 {
let error = ProtocolError::ControlFrameTooBig(payload_len as usize);
return Err(WsError::ProtocolError {
close_code: 1002,
error,
});
}
if opcode == OpCode::Close {
if payload_len == 1 {
let error = ProtocolError::InvalidCloseFramePayload;
return Err(WsError::ProtocolError {
close_code: 1002,
error,
});
}
if payload_len >= 2 {
let payload = unmasked_frame.payload();
// check close code
let mut code_byte = [0u8; 2];
code_byte.copy_from_slice(&payload[..2]);
let code = u16::from_be_bytes(code_byte);
if code < 1000
|| (1004..=1006).contains(&code)
|| (1015..=2999).contains(&code)
|| code >= 5000
{
let error = ProtocolError::InvalidCloseCode(code);
return Err(WsError::ProtocolError {
close_code: 1002,
error,
});
}
// utf-8 validation
if String::from_utf8(payload[2..].to_vec()).is_err() {
let error = ProtocolError::InvalidUtf8;
return Err(WsError::ProtocolError {
close_code: 1007,
error,
});
}
}
}
Ok(Some(unmasked_frame))
}
OpCode::ReservedNonControl | OpCode::ReservedControl => {
Err(WsError::UnsupportedFrame(opcode))
}
}
}sourcepub fn payload_len(&self) -> u64
pub fn payload_len(&self) -> u64
return payload len
Examples found in repository?
src/codec/frame/mod.rs (line 296)
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
pub fn check_frame(&mut self, unmasked_frame: ReadFrame) -> Result<Option<ReadFrame>, WsError> {
let header = unmasked_frame.header();
let opcode = header.opcode();
match opcode {
OpCode::Continue => {
if !self.fragmented {
return Err(WsError::ProtocolError {
close_code: 1002,
error: ProtocolError::MissInitialFragmentedFrame,
});
}
let (header_len, _) = header.payload_idx();
let fin = header.fin();
let mut buf = unmasked_frame.0;
buf.advance(header_len);
self.fragmented_data.0.unsplit(buf);
if fin {
// if String::from_utf8(fragmented_data.to_vec()).is_err() {
// return Err(WsError::ProtocolError {
// close_code: 1007,
// error: ProtocolError::InvalidUtf8,
// });
// }
let completed_frame = self
.fragmented_data
.replace(ReadFrame::empty(OpCode::Binary));
Ok(Some(completed_frame))
} else {
Ok(None)
}
}
OpCode::Text | OpCode::Binary => {
if self.fragmented {
return Err(WsError::ProtocolError {
close_code: 1002,
error: ProtocolError::NotContinueFrameAfterFragmented,
});
}
if !header.fin() {
self.fragmented = true;
self.fragmented_type = opcode.clone();
self.fragmented_data.header_mut().set_opcode(opcode);
let header_len = header.payload_idx().0;
let mut buf = unmasked_frame.0;
buf.advance(header_len);
self.fragmented_data.0.unsplit(buf);
Ok(None)
} else {
// if opcode == OpCode::Text
// && String::from_utf8(frame.payload_data_unmask().to_vec()).is_err()
// {
// return Err(WsError::ProtocolError {
// close_code: 1007,
// error: ProtocolError::InvalidUtf8,
// });
// }
Ok(Some(unmasked_frame))
}
}
OpCode::Close | OpCode::Ping | OpCode::Pong => {
if !header.fin() {
return Err(WsError::ProtocolError {
close_code: 1002,
error: ProtocolError::FragmentedControlFrame,
});
}
let payload_len = header.payload_len();
if payload_len > 125 {
let error = ProtocolError::ControlFrameTooBig(payload_len as usize);
return Err(WsError::ProtocolError {
close_code: 1002,
error,
});
}
if opcode == OpCode::Close {
if payload_len == 1 {
let error = ProtocolError::InvalidCloseFramePayload;
return Err(WsError::ProtocolError {
close_code: 1002,
error,
});
}
if payload_len >= 2 {
let payload = unmasked_frame.payload();
// check close code
let mut code_byte = [0u8; 2];
code_byte.copy_from_slice(&payload[..2]);
let code = u16::from_be_bytes(code_byte);
if code < 1000
|| (1004..=1006).contains(&code)
|| (1015..=2999).contains(&code)
|| code >= 5000
{
let error = ProtocolError::InvalidCloseCode(code);
return Err(WsError::ProtocolError {
close_code: 1002,
error,
});
}
// utf-8 validation
if String::from_utf8(payload[2..].to_vec()).is_err() {
let error = ProtocolError::InvalidUtf8;
return Err(WsError::ProtocolError {
close_code: 1007,
error,
});
}
}
}
Ok(Some(unmasked_frame))
}
OpCode::ReservedNonControl | OpCode::ReservedControl => {
Err(WsError::UnsupportedFrame(opcode))
}
}
}sourcepub fn payload_idx(&self) -> (usize, usize)
pub fn payload_idx(&self) -> (usize, usize)
return (headerlen, the whole frame len)
Examples found in repository?
src/frame.rs (line 477)
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
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]
}More examples
src/codec/frame/mod.rs (line 241)
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
pub fn check_frame(&mut self, unmasked_frame: ReadFrame) -> Result<Option<ReadFrame>, WsError> {
let header = unmasked_frame.header();
let opcode = header.opcode();
match opcode {
OpCode::Continue => {
if !self.fragmented {
return Err(WsError::ProtocolError {
close_code: 1002,
error: ProtocolError::MissInitialFragmentedFrame,
});
}
let (header_len, _) = header.payload_idx();
let fin = header.fin();
let mut buf = unmasked_frame.0;
buf.advance(header_len);
self.fragmented_data.0.unsplit(buf);
if fin {
// if String::from_utf8(fragmented_data.to_vec()).is_err() {
// return Err(WsError::ProtocolError {
// close_code: 1007,
// error: ProtocolError::InvalidUtf8,
// });
// }
let completed_frame = self
.fragmented_data
.replace(ReadFrame::empty(OpCode::Binary));
Ok(Some(completed_frame))
} else {
Ok(None)
}
}
OpCode::Text | OpCode::Binary => {
if self.fragmented {
return Err(WsError::ProtocolError {
close_code: 1002,
error: ProtocolError::NotContinueFrameAfterFragmented,
});
}
if !header.fin() {
self.fragmented = true;
self.fragmented_type = opcode.clone();
self.fragmented_data.header_mut().set_opcode(opcode);
let header_len = header.payload_idx().0;
let mut buf = unmasked_frame.0;
buf.advance(header_len);
self.fragmented_data.0.unsplit(buf);
Ok(None)
} else {
// if opcode == OpCode::Text
// && String::from_utf8(frame.payload_data_unmask().to_vec()).is_err()
// {
// return Err(WsError::ProtocolError {
// close_code: 1007,
// error: ProtocolError::InvalidUtf8,
// });
// }
Ok(Some(unmasked_frame))
}
}
OpCode::Close | OpCode::Ping | OpCode::Pong => {
if !header.fin() {
return Err(WsError::ProtocolError {
close_code: 1002,
error: ProtocolError::FragmentedControlFrame,
});
}
let payload_len = header.payload_len();
if payload_len > 125 {
let error = ProtocolError::ControlFrameTooBig(payload_len as usize);
return Err(WsError::ProtocolError {
close_code: 1002,
error,
});
}
if opcode == OpCode::Close {
if payload_len == 1 {
let error = ProtocolError::InvalidCloseFramePayload;
return Err(WsError::ProtocolError {
close_code: 1002,
error,
});
}
if payload_len >= 2 {
let payload = unmasked_frame.payload();
// check close code
let mut code_byte = [0u8; 2];
code_byte.copy_from_slice(&payload[..2]);
let code = u16::from_be_bytes(code_byte);
if code < 1000
|| (1004..=1006).contains(&code)
|| (1015..=2999).contains(&code)
|| code >= 5000
{
let error = ProtocolError::InvalidCloseCode(code);
return Err(WsError::ProtocolError {
close_code: 1002,
error,
});
}
// utf-8 validation
if String::from_utf8(payload[2..].to_vec()).is_err() {
let error = ProtocolError::InvalidUtf8;
return Err(WsError::ProtocolError {
close_code: 1007,
error,
});
}
}
}
Ok(Some(unmasked_frame))
}
OpCode::ReservedNonControl | OpCode::ReservedControl => {
Err(WsError::UnsupportedFrame(opcode))
}
}
}