The standard library Threadkit_Binary_Io api defines access to basic low-level file binary read and write functionality.
The Threadkit_Binary_Io api is implemented by the threadkit_binary_io_g generic package.
The Threadkit_Binary_Io api is implemented by the threadkit_binary_io package.
The Threadkit_Binary_Io api source code is in src/lib/std/src/io/threadkit-binary-io.api.
The above information is manually maintained and may contain errors.
api {
Vector ;
Element ;
Input_Stream ;
Output_Stream ;
read : Input_Stream -> Vector;
read_one : Input_Stream -> Null_Or(Element );
read_n : (Input_Stream , Int) -> Vector;
read_all : Input_Stream -> Vector;
can_read : (Input_Stream , Int) -> Null_Or(Int );
lookahead : Input_Stream -> Null_Or(Element );
close_input : Input_Stream -> Void;
end_of_stream : Input_Stream -> Bool;
write : (Output_Stream , Vector) -> Void;
write_one : (Output_Stream , Element) -> Void;
flush : Output_Stream -> Void;
close_output : Output_Stream -> Void;
package pure_io : api {
Vector = Vector;
Element = one_byte_unt::Unt;
Stream_Reader = Stream_Reader;
Stream_Writer = Stream_Writer;
Input_Stream ;
Output_Stream ;
File_Position = File_Position;
Out_Position ;
make_instream : (Stream_Reader , Vector) -> Input_Stream;
read : Input_Stream -> (Vector , Input_Stream);
read_one : Input_Stream -> Null_Or(((Element , Input_Stream)) );
read_n : (Input_Stream , Int) -> (Vector , Input_Stream);
read_all : Input_Stream -> (Vector , Input_Stream);
can_read : (Input_Stream , Int) -> Null_Or(Int );
close_input : Input_Stream -> Void;
end_of_stream : Input_Stream -> Bool;
get_reader : Input_Stream -> (Stream_Reader , Vector);
file_position_in : Input_Stream -> File_Position;
make_outstream : (Stream_Writer , io_exceptions::Buffering_Mode)
-> Output_Stream;
write : (Output_Stream , Vector) -> Void;
write_one : (Output_Stream , Element) -> Void;
flush : Output_Stream -> Void;
close_output : Output_Stream -> Void;
set_buffering_mode : (Output_Stream , io_exceptions::Buffering_Mode) -> Void;
get_buffering_mode : Output_Stream -> io_exceptions::Buffering_Mode;
get_writer : Output_Stream
-> (Stream_Writer , io_exceptions::Buffering_Mode);
file_pos_out : Out_Position -> File_Position;
get_output_position : Output_Stream -> Out_Position;
set_output_position : Out_Position -> Void;
input1evt : Input_Stream
-> Mailop(Null_Or(((Element , Input_Stream)) ) );
input_nevt : (Input_Stream , Int)
-> Mailop(((Vector , Input_Stream)) );
input_mailop : Input_Stream -> Mailop(((Vector , Input_Stream)) );
input_all_mailop : Input_Stream -> Mailop(((Vector , Input_Stream)) );
};;
make_instream : pure_io::Input_Stream -> Input_Stream;
get_instream : Input_Stream -> pure_io::Input_Stream;
set_instream : (Input_Stream , pure_io::Input_Stream) -> Void;
get_output_position : Output_Stream -> pure_io::Out_Position;
set_output_position : (Output_Stream , pure_io::Out_Position) -> Void;
make_outstream : pure_io::Output_Stream -> Output_Stream;
get_outstream : Output_Stream -> pure_io::Output_Stream;
set_outstream : (Output_Stream , pure_io::Output_Stream) -> Void;
input1evt : Input_Stream -> Mailop(Null_Or(Element ) );
input_nevt : (Input_Stream , Int) -> Mailop(Vector );
input_mailop : Input_Stream -> Mailop(Vector );
input_all_mailop : Input_Stream -> Mailop(Vector );
open_for_read : String -> Input_Stream;
open_for_write : String -> Output_Stream;
open_for_append : String -> Output_Stream;
sharing pure_io::Element = Element
sharing pure_io::Vector = Vector
};