W3cubDocs

/Elixir 1.18

Source IO.Stream

Defines an IO.Stream struct returned by IO.stream/2 and IO.binstream/2.

The following fields are public:

  • device - the IO device
  • raw - a boolean indicating if bin functions should be used
  • line_or_bytes - if reading should read lines or a given number of bytes

It is worth noting that an IO stream has side effects and every time you go over the stream you may get different results.

Summary

Types

t()

Types

t()Source 

@type t() :: %IO.Stream{
  device: IO.device(),
  line_or_bytes: :line | non_neg_integer(),
  raw: boolean()
}

© 2012-2024 The Elixir Team
Licensed under the Apache License, Version 2.0.
https://hexdocs.pm/elixir/1.18.1/IO.Stream.html