Pudu programming language
Menu
API reference

Std.Buffer.compare

1 declaration

fn

compare: &Std.Buffer.Buffer -> Int -> &Std.Buffer.Buffer -> Int -> Int -> Option[Int]

This is a callable function.

What it does

Compares len bytes between buffer a at aOff and buffer b at bOff.

Follows standard lexicographical ordering (memcmp semantics):

- Returns Some(0) if both byte sequences are identical.

- Returns Some(-1) if the slice in a is lexicographically less than b.

- Returns Some(1) if the slice in a is lexicographically greater than b.

- Returns None if either range exceeds its respective buffer bounds.

Read the signature

  • The text after the name is the type checked by Pudu.
  • Read arrows from left to right: inputs come first, and the final type is returned.
  • & borrows a value for this call instead of moving or copying it.
  • Names inside [ ] are type arguments, such as the item type held by a collection.
  • Option holds Some(value) or None when no value is available.

Back to Std.BufferSearch related declarations