| | |
- builtins.object
-
- FileContentsMap
- irstream
-
- icstream
- izstream
- orstream
-
- ocstream
- ozstream
class FileContentsMap(builtins.object) |
| |
The %FileContentsMap is a class that will minimize the number of times
files are accessed from disk. The first time the contents of a file are
requested, it will cache the contents the file in memory as a strings. All
subsequent requests for the contents of that file will then be delivered
without having to go to disk. WARNING: The %FileContentsMap will not update
the contents that it holds for a file after the first time it loads it, so if
the contents change on disk, the %FileContentsMap will be out of date.
The %FileContentsMap offers two settings that are both off by default.
1) You can set whether it should delete files when they reach a "read limit,"
which in turn requires that you first define a read limit for the file.
This can prevent the %FileContentsMap from loading too much into memory as
long as the utility of a file is expected to be short (i.e. it's read several
times in a short period and then never again). Setting a file's read limit to
zero signals that the contents of the file should never be deleted from memory
i.e. that it has an infinite read limit. If the contents of a file is requested
before read limit has been set, then the read limit is set to zero
(i.e. infinity).
2) You can set whether it should refuse to load unexpected files. Before
you request the contents of a file, you must provide a read limit (zero is
an acceptible value here; see above) for that file, or the %FileContentsMap
will throw an exception when you request that file.
|
| |
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(rosetta.utility.io.FileContentsMap) -> NoneType
2. __init__(self : rosetta.utility.io.FileContentsMap, fcontents : rosetta.std.map_std_string_std_string) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- assign(...) from builtins.PyCapsule
- assign(self : rosetta.utility.io.FileContentsMap, : rosetta.utility.io.FileContentsMap) -> rosetta.utility.io.FileContentsMap
- clear(...) from builtins.PyCapsule
- clear(rosetta.utility.io.FileContentsMap) -> NoneType
Delete the contents of all files and file-read counts from memory
- delete_contents_at_nread_limit(...) from builtins.PyCapsule
- delete_contents_at_nread_limit(*args, **kwargs)
Overloaded function.
1. delete_contents_at_nread_limit(self : rosetta.utility.io.FileContentsMap, setting : bool) -> NoneType
Enable or disable the behavior that the %FileContentsMap will delete
the contents of files from memory after they have been read as many times
as they were expected to be read (their read limit).
2. delete_contents_at_nread_limit(rosetta.utility.io.FileContentsMap) -> bool
Return the boolean value describing whether the %FileContentsMap will
delete the contents of files from memory after they have reached their
read limit.
- delete_file_contents(...) from builtins.PyCapsule
- delete_file_contents(self : rosetta.utility.io.FileContentsMap, fname : str) -> NoneType
Delete the contents of a particular file from memory
- get_file_contents(...) from builtins.PyCapsule
- get_file_contents(self : rosetta.utility.io.FileContentsMap, fname : str) -> str
Return the string contents of a file, possibly loading the contents of that file
into memory for the first time, always updating internal data, and possibly
deleting the contents of a file if it is expected to no longer be needed.
- get_file_contents_ref(...) from builtins.PyCapsule
- get_file_contents_ref(self : rosetta.utility.io.FileContentsMap, fname : str) -> str
Return a reference to the string contents of a file, possibly loading the contents
of that file into memory for the first time, but not deleting the contents of that file.
- has_file_contents(...) from builtins.PyCapsule
- has_file_contents(self : rosetta.utility.io.FileContentsMap, fname : str) -> bool
Return whether or not the %FileContentsMap has the contents of a file in memory
- has_read_limit_for_file(...) from builtins.PyCapsule
- has_read_limit_for_file(self : rosetta.utility.io.FileContentsMap, fname : str) -> bool
Return whether a read limit (even one of zero) has been set for a file
- increment_nread_limit(...) from builtins.PyCapsule
- increment_nread_limit(self : rosetta.utility.io.FileContentsMap, fname : str) -> NoneType
Increment the internal nread limit for a file
- nread_limit_for_file(...) from builtins.PyCapsule
- nread_limit_for_file(self : rosetta.utility.io.FileContentsMap, fname : str) -> int
Return the read limit that has been set for this file; this will return
a value of zero even if the file has not had a read limit set. Use
has_read_limit to determine if a read limit has been set for a particular file.
- nreads_for_file(...) from builtins.PyCapsule
- nreads_for_file(self : rosetta.utility.io.FileContentsMap, fname : str) -> int
Return the number of times a particular file has been read
- refuse_unexpected_files(...) from builtins.PyCapsule
- refuse_unexpected_files(*args, **kwargs)
Overloaded function.
1. refuse_unexpected_files(self : rosetta.utility.io.FileContentsMap, setting : bool) -> NoneType
Enable or disable the behavior that the FCM will refuse to load a file if
a non-zero expected number of reads for that file has not been previously provided.
2. refuse_unexpected_files(rosetta.utility.io.FileContentsMap) -> bool
Return the boolean value describing whether the %FileContentsMap will refuse
to load files that it does not expect to load.
- set_file_contents(...) from builtins.PyCapsule
- set_file_contents(self : rosetta.utility.io.FileContentsMap, fname : str, contents : str) -> NoneType
Set the contents of a file from an input string thereby avoiding a read from
disk.
- set_nread_limit_for_file(...) from builtins.PyCapsule
- set_nread_limit_for_file(self : rosetta.utility.io.FileContentsMap, fname : str, limit : int) -> NoneType
Set the maximum number of reads for a file; if this is zero, then that
file can be read an indefinite number of times.
|
class icstream(irstream) |
| |
icstream: Input channel stream wrapper class
|
| |
- Method resolution order:
- icstream
- irstream
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(self : handle, i_stream_a : std::istream) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- bad(...) from builtins.PyCapsule
- bad(rosetta.utility.io.icstream) -> bool
Bad?
- clear(...) from builtins.PyCapsule
- clear(rosetta.utility.io.icstream) -> NoneType
Clear the stream
- compressed(...) from builtins.PyCapsule
- compressed(rosetta.utility.io.icstream) -> bool
Compressed?
- eof(...) from builtins.PyCapsule
- eof(rosetta.utility.io.icstream) -> bool
End of file?
- fail(...) from builtins.PyCapsule
- fail(rosetta.utility.io.icstream) -> bool
Fail?
- get(...) from builtins.PyCapsule
- get(*args, **kwargs)
Overloaded function.
1. get(rosetta.utility.io.icstream) -> int
Get the next character
2. get(self : rosetta.utility.io.icstream, c : str) -> rosetta.utility.io.icstream
Get the next character
3. get(self : rosetta.utility.io.icstream, str : str, count : int) -> rosetta.utility.io.icstream
Get the next specified number of characters
4. get(self : rosetta.utility.io.icstream, str : str, count : int, delim : str) -> rosetta.utility.io.icstream
Get the next specified number of characters
5. get(self : rosetta.utility.io.icstream, str : str, count : int) -> rosetta.utility.io.icstream
Get the next specified number of characters
6. get(self : rosetta.utility.io.icstream, str : str, count : int, delim : str) -> rosetta.utility.io.icstream
Get the next specified number of characters
- getline(...) from builtins.PyCapsule
- getline(*args, **kwargs)
Overloaded function.
1. getline(self : rosetta.utility.io.icstream, line : str, count : int) -> rosetta.utility.io.icstream
Get the rest of the line
2. getline(self : rosetta.utility.io.icstream, line : str, count : int, delim : str) -> rosetta.utility.io.icstream
Get the rest of the line
3. getline(self : rosetta.utility.io.icstream, line : str) -> rosetta.utility.io.icstream
Get the rest of the line
4. getline(self : rosetta.utility.io.icstream, line : str, delim : str) -> rosetta.utility.io.icstream
Get the rest of the line
- good(...) from builtins.PyCapsule
- good(rosetta.utility.io.icstream) -> bool
Good?
- gzipped(...) from builtins.PyCapsule
- gzipped(rosetta.utility.io.icstream) -> bool
gzipped?
- ignore(...) from builtins.PyCapsule
- ignore(*args, **kwargs)
Overloaded function.
1. ignore(rosetta.utility.io.icstream) -> rosetta.utility.io.icstream
Skip over the next character
2. ignore(self : rosetta.utility.io.icstream, count : int) -> rosetta.utility.io.icstream
Skip over the next specified number of characters
3. ignore(self : rosetta.utility.io.icstream, count : int, delim : str) -> rosetta.utility.io.icstream
Skip over the next specified number of characters
- peek(...) from builtins.PyCapsule
- peek(rosetta.utility.io.icstream) -> int
Returns the next character without extracting it
- putback(...) from builtins.PyCapsule
- putback(self : rosetta.utility.io.icstream, c : str) -> rosetta.utility.io.icstream
Put the last character read back into the stream and check that passed character is correct
- rdbuf(...) from builtins.PyCapsule
- rdbuf(rosetta.utility.io.icstream) -> rosetta.std.basic_streambuf_char_std_char_traits_char_t
Pointer to the stream buffer
- read(...) from builtins.PyCapsule
- read(*args, **kwargs)
Overloaded function.
1. read(self : rosetta.utility.io.icstream, str : str, count : int) -> rosetta.utility.io.icstream
Read the next specified number of characters
2. read(self : rosetta.utility.io.icstream, str : str, count : int) -> rosetta.utility.io.icstream
Read the next specified number of characters
- readsome(...) from builtins.PyCapsule
- readsome(*args, **kwargs)
Overloaded function.
1. readsome(self : rosetta.utility.io.icstream, str : str, count : int) -> int
Read the next available specified number of characters
2. readsome(self : rosetta.utility.io.icstream, str : str, count : int) -> int
Read the next available specified number of characters
- seek_beg(...) from builtins.PyCapsule
- seek_beg(rosetta.utility.io.icstream) -> NoneType
Seek to the beginning
- uncompressed(...) from builtins.PyCapsule
- uncompressed(rosetta.utility.io.icstream) -> bool
Uncompressed?
- unget(...) from builtins.PyCapsule
- unget(rosetta.utility.io.icstream) -> rosetta.utility.io.icstream
Put the last character read back into the stream
|
class irstream(builtins.object) |
| |
orstream: Input stream wrapper abstract base class
|
| |
Methods defined here:
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- bad(...) from builtins.PyCapsule
- bad(rosetta.utility.io.irstream) -> bool
Bad?
- clear(...) from builtins.PyCapsule
- clear(rosetta.utility.io.irstream) -> NoneType
Clear the stream
- compressed(...) from builtins.PyCapsule
- compressed(rosetta.utility.io.irstream) -> bool
Compressed?
- eof(...) from builtins.PyCapsule
- eof(rosetta.utility.io.irstream) -> bool
End of file?
- fail(...) from builtins.PyCapsule
- fail(rosetta.utility.io.irstream) -> bool
Fail?
- get(...) from builtins.PyCapsule
- get(*args, **kwargs)
Overloaded function.
1. get(rosetta.utility.io.irstream) -> int
Get the next character
2. get(self : rosetta.utility.io.irstream, c : str) -> rosetta.utility.io.irstream
Get the next character
3. get(self : rosetta.utility.io.irstream, str : str, count : int) -> rosetta.utility.io.irstream
Get the next specified number of characters
4. get(self : rosetta.utility.io.irstream, str : str, count : int, delim : str) -> rosetta.utility.io.irstream
Get the next specified number of characters
5. get(self : rosetta.utility.io.irstream, str : str, count : int) -> rosetta.utility.io.irstream
Get the next specified number of characters
6. get(self : rosetta.utility.io.irstream, str : str, count : int, delim : str) -> rosetta.utility.io.irstream
Get the next specified number of characters
- getline(...) from builtins.PyCapsule
- getline(*args, **kwargs)
Overloaded function.
1. getline(self : rosetta.utility.io.irstream, line : str, count : int) -> rosetta.utility.io.irstream
Get the rest of the line
2. getline(self : rosetta.utility.io.irstream, line : str, count : int, delim : str) -> rosetta.utility.io.irstream
Get the rest of the line
3. getline(self : rosetta.utility.io.irstream, line : str) -> rosetta.utility.io.irstream
Get the rest of the line
4. getline(self : rosetta.utility.io.irstream, line : str, delim : str) -> rosetta.utility.io.irstream
Get the rest of the line
- good(...) from builtins.PyCapsule
- good(rosetta.utility.io.irstream) -> bool
Good?
- gzipped(...) from builtins.PyCapsule
- gzipped(rosetta.utility.io.irstream) -> bool
gzipped?
- ignore(...) from builtins.PyCapsule
- ignore(*args, **kwargs)
Overloaded function.
1. ignore(rosetta.utility.io.irstream) -> rosetta.utility.io.irstream
Skip over the next character
2. ignore(self : rosetta.utility.io.irstream, count : int) -> rosetta.utility.io.irstream
Skip over the next specified number of characters
3. ignore(self : rosetta.utility.io.irstream, count : int, delim : str) -> rosetta.utility.io.irstream
Skip over the next specified number of characters
- peek(...) from builtins.PyCapsule
- peek(rosetta.utility.io.irstream) -> int
Returns the next character without extracting it
- putback(...) from builtins.PyCapsule
- putback(self : rosetta.utility.io.irstream, c : str) -> rosetta.utility.io.irstream
Put the last character read back into the stream and check that passed character is correct
- rdbuf(...) from builtins.PyCapsule
- rdbuf(rosetta.utility.io.irstream) -> rosetta.std.basic_streambuf_char_std_char_traits_char_t
Pointer to the stream buffer
- read(...) from builtins.PyCapsule
- read(*args, **kwargs)
Overloaded function.
1. read(self : rosetta.utility.io.irstream, str : str, count : int) -> rosetta.utility.io.irstream
Read the next specified number of characters
2. read(self : rosetta.utility.io.irstream, str : str, count : int) -> rosetta.utility.io.irstream
Read the next specified number of characters
- readsome(...) from builtins.PyCapsule
- readsome(*args, **kwargs)
Overloaded function.
1. readsome(self : rosetta.utility.io.irstream, str : str, count : int) -> int
Read the next available specified number of characters
2. readsome(self : rosetta.utility.io.irstream, str : str, count : int) -> int
Read the next available specified number of characters
- seek_beg(...) from builtins.PyCapsule
- seek_beg(rosetta.utility.io.irstream) -> NoneType
Seek to the beginning
- uncompressed(...) from builtins.PyCapsule
- uncompressed(rosetta.utility.io.irstream) -> bool
Uncompressed?
- unget(...) from builtins.PyCapsule
- unget(rosetta.utility.io.irstream) -> rosetta.utility.io.irstream
Put the last character read back into the stream
|
class izstream(irstream) |
| |
izstream: Input file stream wrapper for uncompressed and compressed files
|
| |
- Method resolution order:
- izstream
- irstream
- builtins.object
Methods defined here:
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(handle, str) -> NoneType
doc
3. __init__(self : handle, filename_a : str, open_mode : rosetta.std._Ios_Openmode) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- bad(...) from builtins.PyCapsule
- bad(rosetta.utility.io.izstream) -> bool
Bad?
- clear(...) from builtins.PyCapsule
- clear(rosetta.utility.io.izstream) -> NoneType
Clear the stream(s)
- close(...) from builtins.PyCapsule
- close(rosetta.utility.io.izstream) -> NoneType
Close the ifstream and reset the state
- compressed(...) from builtins.PyCapsule
- compressed(rosetta.utility.io.izstream) -> bool
Compressed?
- eof(...) from builtins.PyCapsule
- eof(rosetta.utility.io.izstream) -> bool
End of file?
- fail(...) from builtins.PyCapsule
- fail(rosetta.utility.io.izstream) -> bool
Fail?
- filename(...) from builtins.PyCapsule
- filename(rosetta.utility.io.izstream) -> str
File name
- gcount(...) from builtins.PyCapsule
- gcount(rosetta.utility.io.izstream) -> int
Get the number of characters read by the last unformatted read
- get(...) from builtins.PyCapsule
- get(*args, **kwargs)
Overloaded function.
1. get(rosetta.utility.io.izstream) -> int
Get the next character
2. get(self : rosetta.utility.io.izstream, c : str) -> rosetta.utility.io.izstream
Get the next character
3. get(self : rosetta.utility.io.izstream, str : str, count : int) -> rosetta.utility.io.izstream
Get the next specified number of characters
4. get(self : rosetta.utility.io.izstream, str : str, count : int, delim : str) -> rosetta.utility.io.izstream
Get the next specified number of characters
5. get(self : rosetta.utility.io.izstream, str : str, count : int) -> rosetta.utility.io.izstream
Get the next specified number of characters
6. get(self : rosetta.utility.io.izstream, str : str, count : int, delim : str) -> rosetta.utility.io.izstream
Get the next specified number of characters
- get_alternative_search_paths(...) from builtins.PyCapsule
- get_alternative_search_paths() -> rosetta.utility.vector1_std_string
- getline(...) from builtins.PyCapsule
- getline(*args, **kwargs)
Overloaded function.
1. getline(self : rosetta.utility.io.izstream, line : str, count : int) -> rosetta.utility.io.izstream
Get the rest of the line
2. getline(self : rosetta.utility.io.izstream, line : str, count : int, delim : str) -> rosetta.utility.io.izstream
Get the rest of the line
3. getline(self : rosetta.utility.io.izstream, line : str) -> rosetta.utility.io.izstream
Get the rest of the line
4. getline(self : rosetta.utility.io.izstream, line : str, delim : str) -> rosetta.utility.io.izstream
Get the rest of the line
- good(...) from builtins.PyCapsule
- good(rosetta.utility.io.izstream) -> bool
Good?
- gzipped(...) from builtins.PyCapsule
- gzipped(rosetta.utility.io.izstream) -> bool
gzipped?
- ignore(...) from builtins.PyCapsule
- ignore(*args, **kwargs)
Overloaded function.
1. ignore(rosetta.utility.io.izstream) -> rosetta.utility.io.izstream
Skip over the next character
2. ignore(self : rosetta.utility.io.izstream, count : int) -> rosetta.utility.io.izstream
Skip over the next specified number of characters
3. ignore(self : rosetta.utility.io.izstream, count : int, delim : str) -> rosetta.utility.io.izstream
Skip over the next specified number of characters
- open(...) from builtins.PyCapsule
- open(*args, **kwargs)
Overloaded function.
1. open(self : rosetta.utility.io.izstream, filename_a : str) -> NoneType
Open a file
2. open(self : rosetta.utility.io.izstream, filename_a : str, open_mode : rosetta.std._Ios_Openmode) -> NoneType
Open a file
- peek(...) from builtins.PyCapsule
- peek(rosetta.utility.io.izstream) -> int
Returns the next character without extracting it
- putback(...) from builtins.PyCapsule
- putback(self : rosetta.utility.io.izstream, c : str) -> rosetta.utility.io.izstream
Put the last character read back into the stream and check
that passed character is correct
- rdbuf(...) from builtins.PyCapsule
- rdbuf(rosetta.utility.io.izstream) -> rosetta.std.basic_streambuf_char_std_char_traits_char_t
Pointer to the stream buffer
- read(...) from builtins.PyCapsule
- read(*args, **kwargs)
Overloaded function.
1. read(self : rosetta.utility.io.izstream, str : str, count : int) -> rosetta.utility.io.izstream
Read the next specified number of characters
2. read(self : rosetta.utility.io.izstream, str : str, count : int) -> rosetta.utility.io.izstream
Read the next specified number of characters
- readsome(...) from builtins.PyCapsule
- readsome(*args, **kwargs)
Overloaded function.
1. readsome(self : rosetta.utility.io.izstream, str : str, count : int) -> int
Read the next available specified number of characters
2. readsome(self : rosetta.utility.io.izstream, str : str, count : int) -> int
Read the next available specified number of characters
- seek_beg(...) from builtins.PyCapsule
- seek_beg(rosetta.utility.io.izstream) -> NoneType
Seek to the beginning
- set_alternative_search_paths(...) from builtins.PyCapsule
- set_alternative_search_paths(alternative_search_paths : rosetta.utility.vector1_std_string) -> NoneType
- uncompressed(...) from builtins.PyCapsule
- uncompressed(rosetta.utility.io.izstream) -> bool
Uncompressed?
- unget(...) from builtins.PyCapsule
- unget(rosetta.utility.io.izstream) -> rosetta.utility.io.izstream
Put the last character read back into the stream
|
class orstream(builtins.object) |
| |
orstream: Output stream wrapper base class
|
| |
Methods defined here:
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- bad(...) from builtins.PyCapsule
- bad(rosetta.utility.io.orstream) -> bool
Bad?
- clear(...) from builtins.PyCapsule
- clear(rosetta.utility.io.orstream) -> NoneType
Clear the stream
- compressed(...) from builtins.PyCapsule
- compressed(rosetta.utility.io.orstream) -> bool
Compressed?
- eof(...) from builtins.PyCapsule
- eof(rosetta.utility.io.orstream) -> bool
End of file?
- fail(...) from builtins.PyCapsule
- fail(rosetta.utility.io.orstream) -> bool
Fail?
- flush(...) from builtins.PyCapsule
- flush(rosetta.utility.io.orstream) -> rosetta.utility.io.orstream
Flush the stream
- good(...) from builtins.PyCapsule
- good(rosetta.utility.io.orstream) -> bool
Good?
- gzipped(...) from builtins.PyCapsule
- gzipped(rosetta.utility.io.orstream) -> bool
gzipped?
- put(...) from builtins.PyCapsule
- put(self : rosetta.utility.io.orstream, c : str) -> rosetta.utility.io.orstream
Write a char
- rdbuf(...) from builtins.PyCapsule
- rdbuf(rosetta.utility.io.orstream) -> rosetta.std.basic_streambuf_char_std_char_traits_char_t
Pointer to the stream buffer
- uncompressed(...) from builtins.PyCapsule
- uncompressed(rosetta.utility.io.orstream) -> bool
Uncompressed?
- write(...) from builtins.PyCapsule
- write(*args, **kwargs)
Overloaded function.
1. write(self : rosetta.utility.io.orstream, str : str, count : int) -> rosetta.utility.io.orstream
Write a string
2. write(self : rosetta.utility.io.orstream, str : str, count : int) -> rosetta.utility.io.orstream
Write a string
|
class ozstream(orstream) |
| |
ozstream: Output file stream wrapper for uncompressed and compressed files
|
| |
- Method resolution order:
- ozstream
- orstream
- builtins.object
Methods defined here:
- MPI_reroute_rank(...) from builtins.PyCapsule
- MPI_reroute_rank() -> int
- __init__(...) from builtins.PyCapsule
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(handle) -> NoneType
2. __init__(handle, str) -> NoneType
doc
3. __init__(handle, str, rosetta.std._Ios_Openmode) -> NoneType
doc
4. __init__(self : handle, filename_a : str, open_mode : rosetta.std._Ios_Openmode, buf_size : int) -> NoneType
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
- bad(...) from builtins.PyCapsule
- bad(rosetta.utility.io.ozstream) -> bool
Bad?
- buffer_size(...) from builtins.PyCapsule
- buffer_size(*args, **kwargs)
Overloaded function.
1. buffer_size(rosetta.utility.io.ozstream) -> int
get buffer size (bytes)
In uncompressed mode this is the size of the character buffer.
In compressed mode this is the size of the zip buffer.
2. buffer_size(self : rosetta.utility.io.ozstream, buf_size : int) -> NoneType
set buffer size (bytes)
In uncompressed mode this is the size of the character buffer.
In compressed mode this is the size of the zip buffer.
Lower bound of 4KB is enforced due to zipstream requirements.
Operation is skipped if the file is currently open, as the
buffer is considered locked.
- clear(...) from builtins.PyCapsule
- clear(rosetta.utility.io.ozstream) -> NoneType
Clear the stream
- close(...) from builtins.PyCapsule
- close(rosetta.utility.io.ozstream) -> NoneType
Close the ofstream and reset the state
- compressed(...) from builtins.PyCapsule
- compressed(rosetta.utility.io.ozstream) -> bool
Compressed?
- enable_MPI_reroute(...) from builtins.PyCapsule
- enable_MPI_reroute(min_client_rank : int, master_rank : int) -> NoneType
- eof(...) from builtins.PyCapsule
- eof(rosetta.utility.io.ozstream) -> bool
End of file?
- fail(...) from builtins.PyCapsule
- fail(rosetta.utility.io.ozstream) -> bool
Fail?
- filename(...) from builtins.PyCapsule
- filename(rosetta.utility.io.ozstream) -> str
File name
- flush(...) from builtins.PyCapsule
- flush(rosetta.utility.io.ozstream) -> rosetta.utility.io.ozstream
Flush the stream -- currently alias to flush_finalize()
Instead doing a regular flush, we currently force a
completion of the zip stream. We do this to pre-empt
against several things: (1) the expensive operation
of closing and re-opening a stream (2) confusion and
inconvenience that may result from users calling flushes
and ending upon with broken or corrupted files if a
job is somehow interrupted (e.g. on a cluster).
Please note that calling flush_finalize() too often
can seriously degrade compression. zlib documentation
appears to imply that every 1MB or so is a reasonable
rule of thumb.
- flush_finalize(...) from builtins.PyCapsule
- flush_finalize(rosetta.utility.io.ozstream) -> rosetta.utility.io.ozstream
Flush the streams and finalize the zip stream
Calling this will complete the zip stream.
Upon the next write, a new zip stream will be started.
Please note that calling flush_finalize() too often
can seriously degrade compression. zlib documentation
appears to imply that every 1MB or so is a reasonable
rule of thumb.
- good(...) from builtins.PyCapsule
- good(rosetta.utility.io.ozstream) -> bool
Good?
- gzipped(...) from builtins.PyCapsule
- gzipped(rosetta.utility.io.ozstream) -> bool
gzipped?
- open(...) from builtins.PyCapsule
- open(*args, **kwargs)
Overloaded function.
1. open(self : rosetta.utility.io.ozstream, filename_a : str) -> NoneType
Open a file
2. open(self : rosetta.utility.io.ozstream, filename_a : str, open_mode : rosetta.std._Ios_Openmode) -> NoneType
Open a file
- open_append(...) from builtins.PyCapsule
- open_append(self : rosetta.utility.io.ozstream, filename_a : str) -> NoneType
Open a text file for appending
- open_append_if_existed(...) from builtins.PyCapsule
- open_append_if_existed(self : rosetta.utility.io.ozstream, filename_a : str, preprinted_header : std::basic_stringstream<char, std::char_traits<char>, std::allocator<char> >) -> NoneType
open file as append if it exists, return true if file existed before, false if it is new.
- put(...) from builtins.PyCapsule
- put(self : rosetta.utility.io.ozstream, c : str) -> rosetta.utility.io.ozstream
Write a char
- rdbuf(...) from builtins.PyCapsule
- rdbuf(rosetta.utility.io.ozstream) -> rosetta.std.basic_streambuf_char_std_char_traits_char_t
Pointer to the stream buffer
- uncompressed(...) from builtins.PyCapsule
- uncompressed(rosetta.utility.io.ozstream) -> bool
Uncompressed?
- write(...) from builtins.PyCapsule
- write(*args, **kwargs)
Overloaded function.
1. write(self : rosetta.utility.io.ozstream, str : str, count : int) -> rosetta.utility.io.ozstream
Write a string
2. write(self : rosetta.utility.io.ozstream, str : str, count : int) -> rosetta.utility.io.ozstream
Write a string
- zflush(...) from builtins.PyCapsule
- zflush(rosetta.utility.io.ozstream) -> NoneType
Flush the zip_ostream
this will flush but *not* finalize the zip stream
- zflush_finalize(...) from builtins.PyCapsule
- zflush_finalize(rosetta.utility.io.ozstream) -> NoneType
Flush and finalize the zip_stream
Calling this will complete the zip stream.
Upon the next write, a new zip stream will be started
Please note that calling zflush_finalize() too often
can seriously degrade compression. zlib documentation
appears to imply that every 1MB or so is a reasonable
rule of thumb.
| |