class TDS::PacketIO

Included Modules

Defined in:

tds/packet_io.cr

Constant Summary

HDR_LEN = 8_u16
MIN_SIZE = 512
NETWORK_ENCODING = IO::ByteFormat::NetworkEndian

Constructors

Class Method Summary

Instance Method Summary

Macros inherited from module TDS::Trace

trace(value) trace, trace_pop trace_pop, trace_push trace_push

Constructor Detail

def self.new(io : IO, type : Type, mode : Mode, size : Int32) #

[View source]

Class Method Detail

def self.recv(io : IO, expected_type : Type, size = MIN_SIZE, &block : IO -> Nil) #

[View source]
def self.send(io : IO, type : Type, size = MIN_SIZE, &block : IO -> Nil) #

[View source]

Instance Method Detail

def close #
Description copied from class IO

Closes this IO.

IO defines this is a no-op method, but including types may override.


[View source]
def pos #
Description copied from class IO

Returns the current position (in bytes) in this IO.

The IO class raises on this method, but some subclasses, notable IO::FileDescriptor and IO::Memory implement it.

File.write("testfile", "hello")

file = File.new("testfile")
file.pos     # => 0
file.gets(2) # => "he"
file.pos     # => 2

[View source]
def read(slice : Bytes) #
Description copied from class IO

Reads at most slice.size bytes from this IO into slice. Returns the number of bytes read, which is 0 if and only if there is no more data to read (so checking for 0 is the way to detect end of file).

io = IO::Memory.new "hello"
slice = Bytes.new(4)
io.read(slice) # => 4
slice          # => Bytes[104, 101, 108, 108]
io.read(slice) # => 1
slice          # => Bytes[111, 101, 108, 108]
io.read(slice) # => 0

[View source]
def seek(offset, whence : Seek = IO::Seek::Set) #
Description copied from class IO

Seeks to a given offset (in bytes) according to the whence argument.

The IO class raises on this method, but some subclasses, notable IO::FileDescriptor and IO::Memory implement it.

Returns self.

File.write("testfile", "abc")

file = File.new("testfile")
file.gets(3) # => "abc"
file.seek(1, IO::Seek::Set)
file.gets(2) # => "bc"
file.seek(-1, IO::Seek::Current)
file.gets(1) # => "c"

[View source]
def write(slice : Bytes) : Nil #
Description copied from class IO

Writes the contents of slice into this IO.

io = IO::Memory.new
slice = Bytes.new(4) { |i| ('a'.ord + i).to_u8 }
io.write(slice)
io.to_s # => "abcd"

[View source]