class IO::Delimited

Overview

An IO that wraps another IO, and only reads up to the beginning of a specified delimiter.

This is useful for exposing part of an underlying stream to a client.

io = IO::Memory.new "abc||123"
delimited = IO::Delimited.new(io, read_delimiter: "||")

delimited.gets_to_end # => "abc"
delimited.gets_to_end # => ""
io.gets_to_end        # => "123"

Included Modules

Defined in:

io/delimited.cr

Class Method Summary

Instance Method Summary

Instance methods inherited from module IO

<<(obj) : self <<, close close, closed? closed?, each_byte
each_byte(&block) : Nil
each_byte
, each_char(&block) : Nil
each_char
each_char
, each_line(*args, **options, &block) : Nil
each_line(*args, **options)
each_line
, encoding : String encoding, flush flush, gets(limit : Int, chomp = false) : String?
gets(delimiter : Char, chomp = false) : String?
gets(delimiter : String, chomp = false) : String?
gets(chomp = true) : String?
gets(delimiter : Char, limit : Int, chomp = false) : String?
gets
, gets_to_end : String gets_to_end, peek : Bytes? peek, print(*objects : _) : Nil
print(obj) : Nil
print
, printf(format_string, args : Array | Tuple) : Nil
printf(format_string, *args) : Nil
printf
, puts(*objects : _) : Nil
puts : Nil
puts(obj) : Nil
puts(string : String) : Nil
puts
, read(slice : Bytes) read, read_byte : UInt8? read_byte, read_bytes(type, format : IO::ByteFormat = IO::ByteFormat::SystemEndian) read_bytes, read_char : Char? read_char, read_fully(slice : Bytes) read_fully, read_fully?(slice : Bytes) read_fully?, read_line(*args, **options) : String? read_line, read_string(bytesize : Int) : String read_string, read_utf8(slice : Bytes) read_utf8, read_utf8_byte read_utf8_byte, rewind rewind, set_encoding(encoding : String, invalid : Symbol? = nil) set_encoding, skip(bytes_count : Int) : Nil skip, skip_to_end : Nil skip_to_end, tty? : Bool tty?, write(slice : Bytes) : Nil write, write_byte(byte : UInt8) write_byte, write_bytes(object, format : IO::ByteFormat = IO::ByteFormat::SystemEndian) write_bytes, write_utf8(slice : Bytes) write_utf8

Class methods inherited from module IO

copy(src, dst, limit : Int)
copy(src, dst)
copy
, pipe(read_blocking = false, write_blocking = false)
pipe(read_blocking = false, write_blocking = false, &block)
pipe

Instance methods inherited from class Reference

==(other : self)
==(other)
==
, dup dup, hash hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference)
same?(other : Nil)
same?
, to_s(io : IO) : Nil to_s

Class methods inherited from class Reference

new new

Instance methods inherited from class Object

!=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
===(other)
===
, =~(other) =~, class class, dup dup, hash hash, inspect(io : IO)
inspect
inspect
, itself itself, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, tap(&block) tap, to_json(io : IO)
to_json
to_json
, to_pretty_json(indent : String = " ")
to_pretty_json(io : IO, indent : String = " ")
to_pretty_json
, to_s
to_s(io : IO)
to_s
, to_yaml(io : IO)
to_yaml
to_yaml
, try(&block) try

Class methods inherited from class Object

from_json(string_or_io, root : String) : self
from_json(string_or_io) : self
from_json
, from_yaml(string_or_io) : self from_yaml

Class Method Detail

def self.new(io : IO, read_delimiter : String, sync_close : Bool = false) #

Creates a new IO::Delimited which wraps io, and can read until the byte sequence read_delimiter (interpreted as UTF-8) is found. If sync_close is set, calling #close calls #close on the underlying IO.


[View source]
def self.new(io : IO, read_delimiter : Bytes, sync_close : Bool = false) #

Creates a new IO::Delimited which wraps io, and can read until the byte sequence read_delimiter is found. If sync_close is set, calling #close calls #close on the underlying IO.


[View source]

Instance Method Detail

def close #

[View source]
def closed? : Bool #

[View source]
def read(slice : Bytes) #

[View source]
def read_delimiter : Slice(UInt8) #

[View source]
def sync_close=(sync_close) #

If #sync_close? is true, closing this IO will close the underlying IO.


[View source]
def sync_close? : Bool #

If #sync_close? is true, closing this IO will close the underlying IO.


[View source]
def write(slice : Bytes) #

[View source]