FSharpx.Collections


ByteString Module

Functions and values

Function or value Description

ByteString.append a b

Full Usage: ByteString.append a b

Parameters:
Returns: ByteString

append uses Buffer.BlockCopy for efficient array operations. Please note that a new array is created and both arrays are copied in, disregarding any additional bytes in the original, underlying arrays.

a : ByteString
b : ByteString
Returns: ByteString

ByteString.cons hd bs

Full Usage: ByteString.cons hd bs

Parameters:
Returns: ByteString

cons uses Buffer.SetByte and Buffer.BlockCopy for efficient array operations. Please note that a new array is created and both the head and tail are copied in, disregarding any additional bytes in the original tail array.

hd : byte
bs : ByteString
Returns: ByteString

ByteString.create arr

Full Usage: ByteString.create arr

Parameters:
    arr : byte[]

Returns: ByteString

needs .fsi file

arr : byte[]
Returns: ByteString

ByteString.empty

Full Usage: ByteString.empty

Returns: ByteString

needs .fsi file

Returns: ByteString

ByteString.findIndex pred bs

Full Usage: ByteString.findIndex pred bs

Parameters:
Returns: int

needs .fsi file

pred : byte -> bool
bs : ByteString
Returns: int

ByteString.fold f seed bs

Full Usage: ByteString.fold f seed bs

Parameters:
Returns: 'a

needs .fsi file

f : 'a -> byte -> 'a
seed : 'a
bs : ByteString
Returns: 'a

ByteString.head bs

Full Usage: ByteString.head bs

Parameters:
Returns: byte

needs .fsi file

bs : ByteString
Returns: byte

ByteString.index bs pos

Full Usage: ByteString.index bs pos

Parameters:
Returns: byte

needs .fsi file

bs : ByteString
pos : int
Returns: byte

ByteString.isEmpty bs

Full Usage: ByteString.isEmpty bs

Parameters:
Returns: bool

needs .fsi file

bs : ByteString
Returns: bool

ByteString.length bs

Full Usage: ByteString.length bs

Parameters:
Returns: int

needs .fsi file

bs : ByteString
Returns: int

ByteString.ofArraySegment segment

Full Usage: ByteString.ofArraySegment segment

Parameters:
Returns: ByteString

needs .fsi file

segment : ArraySegment<byte>
Returns: ByteString

ByteString.ofList l

Full Usage: ByteString.ofList l

Parameters:
    l : byte list

Returns: ByteString

needs .fsi file

l : byte list
Returns: ByteString

ByteString.ofSeq s

Full Usage: ByteString.ofSeq s

Parameters:
    s : seq<byte>

Returns: ByteString

needs .fsi file

s : seq<byte>
Returns: ByteString

ByteString.ofString s

Full Usage: ByteString.ofString s

Parameters:
    s : string

Returns: ByteString

needs .fsi file

s : string
Returns: ByteString

ByteString.singleton c

Full Usage: ByteString.singleton c

Parameters:
    c : byte

Returns: ByteString

needs .fsi file

c : byte
Returns: ByteString

ByteString.skip n bs

Full Usage: ByteString.skip n bs

Parameters:
Returns: ByteString

needs .fsi file

n : int
bs : ByteString
Returns: ByteString

ByteString.skipUntil pred bs

Full Usage: ByteString.skipUntil pred bs

Parameters:
Returns: ByteString

needs .fsi file

pred : byte -> bool
bs : ByteString
Returns: ByteString

ByteString.skipWhile pred bs

Full Usage: ByteString.skipWhile pred bs

Parameters:
Returns: ByteString

needs .fsi file

pred : byte -> bool
bs : ByteString
Returns: ByteString

ByteString.span pred bs

Full Usage: ByteString.span pred bs

Parameters:
Returns: ByteString * ByteString

needs .fsi file

pred : byte -> bool
bs : ByteString
Returns: ByteString * ByteString

ByteString.split pred bs

Full Usage: ByteString.split pred bs

Parameters:
Returns: ByteString * ByteString

needs .fsi file

pred : byte -> bool
bs : ByteString
Returns: ByteString * ByteString

ByteString.splitAt n bs

Full Usage: ByteString.splitAt n bs

Parameters:
Returns: ByteString * ByteString

needs .fsi file

n : int
bs : ByteString
Returns: ByteString * ByteString

ByteString.tail bs

Full Usage: ByteString.tail bs

Parameters:
Returns: ByteString

needs .fsi file

bs : ByteString
Returns: ByteString

ByteString.take n bs

Full Usage: ByteString.take n bs

Parameters:
Returns: ByteString

needs .fsi file

n : int
bs : ByteString
Returns: ByteString

ByteString.takeUntil pred bs

Full Usage: ByteString.takeUntil pred bs

Parameters:
Returns: ByteString

needs .fsi file

pred : byte -> bool
bs : ByteString
Returns: ByteString

ByteString.takeWhile pred bs

Full Usage: ByteString.takeWhile pred bs

Parameters:
Returns: ByteString

needs .fsi file

pred : byte -> bool
bs : ByteString
Returns: ByteString

ByteString.toArray bs

Full Usage: ByteString.toArray bs

Parameters:
Returns: byte[]

needs .fsi file

bs : ByteString
Returns: byte[]

ByteString.toList bs

Full Usage: ByteString.toList bs

Parameters:
Returns: byte list

needs .fsi file

bs : ByteString
Returns: byte list

ByteString.toSeq bs

Full Usage: ByteString.toSeq bs

Parameters:
Returns: seq<byte>

needs .fsi file

bs : ByteString
Returns: seq<byte>

ByteString.toString bs

Full Usage: ByteString.toString bs

Parameters:
Returns: string

needs .fsi file

bs : ByteString
Returns: string

Active patterns

Active pattern Description

ByteString.(|BS|) x

Full Usage: ByteString.(|BS|) x

Parameters:
Returns: byte[] * int * int

An active pattern for conveniently retrieving the properties of a ByteString.

x : ByteString
Returns: byte[] * int * int