SBStream

class lldb.SBStream

Represents a destination for streaming data output to. By default, a string stream is created.

For example (from test/source-manager/TestSourceManager.py),

# Create the filespec for 'main.c'.
filespec = lldb.SBFileSpec('main.c', False)
source_mgr = self.dbg.GetSourceManager()
# Use a string stream as the destination.
stream = lldb.SBStream()
source_mgr.DisplaySourceLinesWithLineNumbers(filespec,
                                             self.line,
                                             2, # context before
                                             2, # context after
                                             '=>', # prefix for current line
                                             stream)

#    2
#    3    int main(int argc, char const *argv[]) {
# => 4        printf('Hello world.\n'); // Set break point at this line.
#    5        return 0;
#    6    }
self.expect(stream.GetData(), 'Source code displayed correctly',
            exe=False,
    patterns = ['=> %d.*Hello world' % self.line])

Methods Summary

Clear(SBStream self)	If the stream is redirected to a file, forget about the file and if ownership of the file was transferred to this object, close the file.
GetData(SBStream self)	If this stream is not redirected to a file, it will maintain a local cache for the stream data which can be accessed using this accessor.
GetSize(SBStream self)	If this stream is not redirected to a file, it will maintain a local cache for the stream output whose length can be accessed using this accessor.
IsValid(SBStream self)
Print(SBStream self, char const * str)
RedirectToFile(SBStream self, …)	RedirectToFile(SBStream self, SBFile file) RedirectToFile(SBStream self, lldb::FileSP file)
RedirectToFileDescriptor(SBStream self, …)
RedirectToFileHandle(file, transfer_fh_ownership)	DEPRECATED, use RedirectToFile
flush(SBStream self)
write(SBStream self, char const * str)

Methods Documentation

Clear(SBStream self)

If the stream is redirected to a file, forget about the file and if ownership of the file was transferred to this object, close the file. If the stream is backed by a local cache, clear this cache.

GetData(SBStream self) → char const *

If this stream is not redirected to a file, it will maintain a local cache for the stream data which can be accessed using this accessor.

GetSize(SBStream self) → size_t

If this stream is not redirected to a file, it will maintain a local cache for the stream output whose length can be accessed using this accessor.

IsValid(SBStream self) → bool

Print(SBStream self, char const * str)

RedirectToFile(SBStream self, char const * path, bool append)

RedirectToFile(SBStream self, SBFile file) RedirectToFile(SBStream self, lldb::FileSP file)

RedirectToFileDescriptor(SBStream self, int fd, bool transfer_fh_ownership)

RedirectToFileHandle(file: lldb::FileSP, transfer_fh_ownership: bool) → void

DEPRECATED, use RedirectToFile

flush(SBStream self)

write(SBStream self, char const * str)