wresp 0.1.3

RESP (REdis Serialization Protocol) response writer and serializer
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
use std::{result, str};

use crate::error::{Error, Result};

/// libs/common/RespReadUtils.cs:MaxArgumentLengthBytes
///
/// 单个 RESP 元素的长度上限(对齐 Redis 默认 512MB 字符串上限)。
/// C# 语义:超上界按"数据未到齐"返回 false 而非抛错(头已照常消费后才
/// 短路判定)——此处保持同一判定次序与返回语义,调用方据 Ok(false) 走
/// 不完整重试路径
pub const MAX_ARGUMENT_LENGTH_BYTES: i32 = 512 * 1_024 * 1_024;

/// garnet/libs/common/RespReadUtils.cs:TryReadUInt64
#[inline]
pub fn try_read_u64(ptr: &mut &[u8], value: &mut u64, bytes_read: &mut usize) -> Result<bool> {
  *bytes_read = 0;
  *value = 0;
  let mut read_head = *ptr;
  let mut i = 0;

  // Fast path for the first 19 digits.
  while i < 19 {
    if read_head.is_empty() {
      break;
    }

    let next_digit = (read_head[0] as u32).wrapping_sub(b'0' as u32);
    if next_digit > 9 {
      break;
    }

    *value = (10 * *value) + next_digit as u64;
    read_head = &read_head[1..];
    i += 1;
  }

  // Parse remaining digits, while checking for overflows.
  while !read_head.is_empty() {
    let next_digit = (read_head[0] as u32).wrapping_sub(b'0' as u32);
    if next_digit > 9 {
      break;
    }

    if (*value == 1844674407370955161 && next_digit > 5) || (*value > 1844674407370955161) {
      return Err(Error::IntegerOverflow { offset: i });
    }

    *value = (10 * *value) + next_digit as u64;
    read_head = &read_head[1..];
    i += 1;
  }

  *bytes_read = i;
  *ptr = read_head;
  Ok(true)
}

/// garnet/libs/common/RespReadUtils.cs:TryReadSignedLengthHeader
#[inline]
pub fn try_read_signed_length_header(
  length: &mut i32,
  ptr: &mut &[u8],
  expected_sigil: u8,
) -> Result<bool> {
  *length = -1;
  if ptr.len() < 3 {
    return Ok(false);
  }

  let mut read_head = &ptr[1..];
  let negative = read_head[0] == b'-';

  // Special case '_\r\n' (RESP3 NULL value)
  if ptr[0] == b'_' && read_head.len() >= 2 && &read_head[0..2] == b"\r\n" {
    *length = -1;
    *ptr = &read_head[2..];
    return Ok(true);
  }

  // String length headers must start with a '$', array headers with '*'
  if ptr[0] != expected_sigil {
    return Err(Error::UnexpectedToken(ptr[0]));
  }

  // Special case: '$-1' (NULL value)
  if negative {
    if ptr.len() < 5 {
      return Ok(false);
    }

    if &read_head[0..4] == b"-1\r\n" {
      *ptr = &read_head[4..];
      return Ok(true);
    }
    read_head = &read_head[1..];
  }

  // Parse length
  let mut value = 0;
  let mut digits_read = 0;
  if !try_read_u64(&mut read_head, &mut value, &mut digits_read)? {
    return Ok(false);
  }

  if digits_read == 0 {
    let unexpected = read_head.first().copied().unwrap_or(0);
    return Err(Error::UnexpectedToken(unexpected));
  }

  // Validate length
  if value > i32::MAX as u64 && (!negative || value > (i32::MAX as u64) + 1) {
    return Err(Error::IntegerOverflow {
      offset: digits_read,
    });
  }

  // Convert to signed value(经 i64 取负:value == 2^31 时 as i32 即 i32::MIN,
  // 若在 i32 域直接取负 debug 构建会溢出 panic)
  *length = if negative {
    -(value as i64) as i32
  } else {
    value as i32
  };

  // Ensure terminator has been received
  if read_head.len() < 2 {
    return Ok(false);
  }

  if &read_head[0..2] != b"\r\n" {
    let unexpected = read_head.first().copied().unwrap_or(0);
    return Err(Error::UnexpectedToken(unexpected));
  }

  *ptr = &read_head[2..];
  Ok(true)
}

/// garnet/libs/common/RespReadUtils.cs:TryReadUnsignedLengthHeader
#[inline]
pub fn try_read_unsigned_length_header(
  length: &mut i32,
  ptr: &mut &[u8],
  expected_sigil: u8,
) -> Result<bool> {
  if !try_read_signed_length_header(length, ptr, expected_sigil)? {
    return Ok(false);
  }

  if *length < 0 {
    return Err(Error::InvalidStringLength(*length));
  }

  Ok(true)
}

/// garnet/libs/common/RespReadUtils.cs:TryReadUnsignedArrayLength
#[inline]
pub fn try_read_unsigned_array_length(length: &mut i32, ptr: &mut &[u8]) -> Result<bool> {
  try_read_unsigned_length_header(length, ptr, b'*')
}

/// garnet/libs/common/RespReadUtils.cs:TryReadSignedArrayLength
#[inline]
pub fn try_read_signed_array_length(length: &mut i32, ptr: &mut &[u8]) -> Result<bool> {
  try_read_signed_length_header(length, ptr, b'*')
}

/// garnet/libs/common/RespReadUtils.cs:TryReadSignedMapLength
#[inline]
pub fn try_read_signed_map_length(length: &mut i32, ptr: &mut &[u8]) -> Result<bool> {
  try_read_signed_length_header(length, ptr, b'%')
}

/// garnet/libs/common/RespReadUtils.cs:TryReadSignedSetLength
#[inline]
pub fn try_read_signed_set_length(length: &mut i32, ptr: &mut &[u8]) -> Result<bool> {
  try_read_signed_length_header(length, ptr, b'~')
}

/// garnet/libs/common/RespReadUtils.cs:TryReadVerbatimStringLength
#[inline]
pub fn try_read_verbatim_string_length(length: &mut i32, ptr: &mut &[u8]) -> Result<bool> {
  try_read_signed_length_header(length, ptr, b'=')
}

/// garnet/libs/common/RespReadUtils.cs:TrySkipByteArrayWithLengthHeader
#[inline]
pub fn try_skip_byte_array_with_length_header(ptr: &mut &[u8]) -> Result<bool> {
  let mut length = 0;
  if !try_read_unsigned_length_header(&mut length, ptr, b'$')?
    || exceeds_max_argument_length(length)?
  {
    return Ok(false);
  }

  let skip_len = length as usize + 2;
  if ptr.len() < skip_len {
    return Ok(false);
  }

  if &ptr[length as usize..skip_len] != b"\r\n" {
    return Err(Error::UnexpectedToken(ptr[length as usize]));
  }

  *ptr = &ptr[skip_len..];
  Ok(true)
}

/// garnet/libs/common/RespReadUtils.cs:TrySliceWithLengthHeader
#[inline]
pub fn try_slice_with_length_header<'a>(result: &mut &'a [u8], ptr: &mut &'a [u8]) -> Result<bool> {
  *result = &[];

  let mut length = 0;
  if !try_read_unsigned_length_header(&mut length, ptr, b'$')?
    || exceeds_max_argument_length(length)?
  {
    return Ok(false);
  }

  let skip_len = length as usize + 2;
  if ptr.len() < skip_len {
    return Ok(false);
  }

  if &ptr[length as usize..skip_len] != b"\r\n" {
    return Err(Error::UnexpectedToken(ptr[length as usize]));
  }

  *result = &ptr[0..length as usize];
  *ptr = &ptr[skip_len..];

  Ok(true)
}

/// garnet/libs/common/RespReadUtils.cs:TryReadByteArrayWithLengthHeader
#[inline]
pub fn try_read_byte_array_with_length_header(
  result: &mut Vec<u8>,
  ptr: &mut &[u8],
) -> Result<bool> {
  result.clear();
  let mut result_span = &[][..];
  if !try_slice_with_length_header(&mut result_span, ptr)? {
    return Ok(false);
  }

  result.extend_from_slice(result_span);
  Ok(true)
}

/// garnet/libs/common/RespReadUtils.cs:TryReadSpanWithLengthHeader
#[inline]
pub fn try_read_span_with_length_header<'a>(
  result: &mut &'a [u8],
  ptr: &mut &'a [u8],
) -> Result<bool> {
  *result = &[];

  if ptr.len() < 3 {
    return Ok(false);
  }

  let mut length = 0;
  if !try_read_unsigned_length_header(&mut length, ptr, b'$')?
    || exceeds_max_argument_length(length)?
  {
    return Ok(false);
  }

  let skip_len = length as usize + 2;
  if ptr.len() < skip_len {
    return Ok(false);
  }

  if &ptr[length as usize..skip_len] != b"\r\n" {
    return Err(Error::UnexpectedToken(ptr[length as usize]));
  }

  *result = &ptr[0..length as usize];
  *ptr = &ptr[skip_len..];

  Ok(true)
}

/// garnet/libs/common/RespReadUtils.cs:TryReadStringWithLengthHeader
#[inline]
pub fn try_read_string_with_length_header(result: &mut String, ptr: &mut &[u8]) -> Result<bool> {
  let mut result_span = &[][..];
  // 1:1 parity (bug fixed: checked return value)
  if !try_read_span_with_length_header(&mut result_span, ptr)? {
    return Ok(false);
  }

  *result = String::from_utf8_lossy(result_span).into_owned();
  Ok(true)
}

/// garnet/libs/common/RespReadUtils.cs:TryReadPtrWithSignedLengthHeader
#[inline]
pub fn try_read_ptr_with_signed_length_header<'a>(
  result: &mut Option<&'a [u8]>,
  ptr: &mut &'a [u8],
) -> Result<bool> {
  let mut length = 0;
  if !try_read_signed_length_header(&mut length, ptr, b'$')? || exceeds_max_argument_length(length)?
  {
    return Ok(false);
  }

  if length < 0 {
    *result = None;
    return Ok(true);
  }

  let skip_len = length as usize + 2;
  if ptr.len() < skip_len {
    return Ok(false);
  }

  if &ptr[length as usize..skip_len] != b"\r\n" {
    return Err(Error::UnexpectedToken(ptr[length as usize]));
  }

  *result = Some(&ptr[0..length as usize]);
  *ptr = &ptr[skip_len..];
  Ok(true)
}

/// garnet/libs/common/RespReadUtils.cs:TryReadAsSpan
#[inline]
pub fn try_read_as_span<'a>(result: &mut &'a [u8], ptr: &mut &'a [u8]) -> Result<bool> {
  *result = &[];

  if ptr.len() < 2 {
    return Ok(false);
  }

  let mut i = 0;
  while i < ptr.len() - 1 {
    if ptr[i] == b'\r' && ptr[i + 1] == b'\n' {
      *result = &ptr[0..i];
      *ptr = &ptr[i + 2..];
      return Ok(true);
    }
    i += 1;
  }

  Ok(false)
}

/// garnet/libs/common/RespReadUtils.cs:TryReadString
#[inline]
pub fn try_read_string(result: &mut String, ptr: &mut &[u8]) -> Result<bool> {
  let mut result_span = &[][..];
  if !try_read_as_span(&mut result_span, ptr)? {
    return Ok(false);
  }

  *result = String::from_utf8_lossy(result_span).into_owned();
  Ok(true)
}

/// garnet/libs/common/RespReadUtils.cs:TryReadSimpleString
#[inline]
pub fn try_read_simple_string(result: &mut String, ptr: &mut &[u8]) -> Result<bool> {
  if ptr.len() < 2 {
    return Ok(false);
  }

  if ptr[0] != b'+' {
    return Err(Error::UnexpectedToken(ptr[0]));
  }

  *ptr = &ptr[1..];
  try_read_string(result, ptr)
}

/// garnet/libs/common/RespReadUtils.cs:TryReadErrorAsString
#[inline]
pub fn try_read_error_as_string(result: &mut String, ptr: &mut &[u8]) -> Result<bool> {
  if ptr.len() < 2 {
    return Ok(false);
  }

  if ptr[0] != b'-' {
    return Err(Error::UnexpectedToken(ptr[0]));
  }

  *ptr = &ptr[1..];
  try_read_string(result, ptr)
}

/// garnet/libs/common/RespReadUtils.cs:TryReadErrorAsSpan
#[inline]
pub fn try_read_error_as_span<'a>(result: &mut &'a [u8], ptr: &mut &'a [u8]) -> Result<bool> {
  *result = &[];
  if ptr.len() < 2 {
    return Ok(false);
  }

  if ptr[0] != b'-' {
    return Ok(false); // Note: C# returns false instead of throwing for this one!
  }

  *ptr = &ptr[1..];
  try_read_as_span(result, ptr)
}

/// garnet/libs/common/RespReadUtils.cs:TryReadIntegerAsSpan
#[inline]
pub fn try_read_integer_as_span<'a>(result: &mut &'a [u8], ptr: &mut &'a [u8]) -> Result<bool> {
  *result = &[];
  if ptr.len() < 2 {
    return Ok(false);
  }

  if ptr[0] != b':' {
    return Err(Error::UnexpectedToken(ptr[0]));
  }

  *ptr = &ptr[1..];
  try_read_as_span(result, ptr)
}

/// garnet/libs/common/RespReadUtils.cs:TryReadIntegerAsString
#[inline]
pub fn try_read_integer_as_string(result: &mut String, ptr: &mut &[u8]) -> Result<bool> {
  let mut result_span = &[][..];
  let success = try_read_integer_as_span(&mut result_span, ptr)?;
  if success {
    *result = String::from_utf8_lossy(result_span).into_owned();
  }
  Ok(success)
}

/// garnet/libs/common/RespReadUtils.cs:TryReadStringArrayWithLengthHeader
#[inline]
pub fn try_read_string_array_with_length_header(
  result: &mut Vec<String>,
  ptr: &mut &[u8],
) -> Result<bool> {
  result.clear();

  let mut length = 0;
  if !try_read_unsigned_array_length(&mut length, ptr)? {
    return Ok(false);
  }

  for _ in 0..length {
    if ptr.is_empty() {
      return Ok(false);
    }

    let mut item = String::new();
    if ptr[0] == b'$' {
      if !try_read_string_with_length_header(&mut item, ptr)? {
        return Ok(false);
      }
    } else {
      if !try_read_integer_as_string(&mut item, ptr)? {
        return Ok(false);
      }
    }
    result.push(item);
  }

  Ok(true)
}

/// garnet/libs/common/RespReadUtils.cs:TryReadPtrWithLengthHeader
#[inline]
pub fn try_read_ptr_with_length_header<'a>(
  result: &mut &'a [u8],
  len: &mut i32,
  ptr: &mut &'a [u8],
) -> Result<bool> {
  *result = &[];

  if !try_read_unsigned_length_header(len, ptr, b'$')? || exceeds_max_argument_length(*len)? {
    return Ok(false);
  }

  let skip_len = *len as usize + 2;
  if ptr.len() < skip_len {
    return Ok(false);
  }

  if &ptr[*len as usize..skip_len] != b"\r\n" {
    return Err(Error::UnexpectedToken(ptr[*len as usize]));
  }

  *result = &ptr[0..*len as usize];
  *ptr = &ptr[skip_len..];

  Ok(true)
}

/// C# 侧 5 处长度消费辅助(RespReadUtils.cs:700/763/870/935/1158)共用的
/// `length > MaxArgumentLengthBytes` 判定;正数才可能越界,负值(NULL)放行
#[inline]
fn exceeds_max_argument_length(length: i32) -> Result<bool> {
  Ok(length > MAX_ARGUMENT_LENGTH_BYTES)
}

/// 整包应答解析错误形态(脚本 GET/SET 特例回包解析专用)
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ReplyError {
  /// `-ERR...\r\n` 错误应答(脚本执行错误)
  ErrorReply,
  /// 其余不可识别形态(协议错误)
  Malformed,
}

/// 解析整包 RESP 批量串/null 应答(零拷贝返回载荷切片)
///
/// `$len\r\n<payload>\r\n` → `Ok(Some(载荷))`;`$-1\r\n` → `Ok(None)`;
/// `-...\r\n` → `Err(ReplyError::ErrorReply)`;其余 → `Err(ReplyError::Malformed)`
pub fn parse_bulk_reply(reply: &[u8]) -> result::Result<Option<&[u8]>, ReplyError> {
  if reply.first() == Some(&b'$') {
    let text = str::from_utf8(&reply[1..]).map_err(|_| ReplyError::Malformed)?;
    let Some(crlf) = text.find("\r\n") else {
      return Err(ReplyError::Malformed);
    };
    let len: isize = text[..crlf].parse().map_err(|_| ReplyError::Malformed)?;
    if len < 0 {
      return Ok(None);
    }
    let start = 1 + crlf + 2;
    let end = start + len as usize;
    if reply.len() >= end {
      return Ok(Some(&reply[start..end]));
    }
    return Err(ReplyError::Malformed);
  }
  if reply.first() == Some(&b'-') {
    return Err(ReplyError::ErrorReply);
  }
  Err(ReplyError::Malformed)
}

/// 解析整包 RESP 简单串应答(SET 特例回包:`+OK`)
///
/// `+...\r\n` → `Ok(())`;`-...\r\n` → `Err(ReplyError::ErrorReply)`;
/// 其余 → `Err(ReplyError::Malformed)`
pub fn parse_simple_reply(reply: &[u8]) -> result::Result<(), ReplyError> {
  match reply.first() {
    Some(b'+') => Ok(()),
    Some(b'-') => Err(ReplyError::ErrorReply),
    _ => Err(ReplyError::Malformed),
  }
}