Example for using a PipeBuffer() ?

[Uwe Fechner]

Hello,

I would like to convert the content of a pipebuffer int an array of Uint8.

My code so far:

    iob = PipeBuffer();
    write(iob, char(14))
    writeproto(iob, pub.state)

Now I want to print the content of iob as hex string for debugging.

I can use bytes2hex to convert an array of Uint8 to a hex string,
like in this example:

s="Hello world!"
bytes2hex(convert(Array{Uint8, 1}, s))

but I could not find a way to access the content of a PipeBuffer.

Any idea?

Regards:

Uwe

[Ivar Nesje]

Judging from base/iobuffer.jl, you can access iob.data to see the actual Uint8 array that backs a PipeBuffer.

Just note that type fields is not considered part of the exported and (somewhat) stable interface.

Ivar

[Uwe Fechner]

Thanks, iob.data works.

Is there a way in Julia to find out what are the field names of a Type, like the dir function in Python?

Best regards:

Uwe

[Mike Innes]

names(Type) may be what you are looking for, e.g. names(Complex) => [:re, :im]

[Uwe Fechner]

Thanks, this is working for me:

julia> iob = PipeBuffer()
IOBuffer([],true,true,false,true,0,9223372036854775807,1)

julia> names(iob)
8-element Array{Any,1}:
 :data   
 :readable
 :writable
 :seekable
 :append 
 :size   
 :maxsize
 :ptr    

julia>

Uwe

[Ivar Nesje]

Or you can search in the /base directory in the source. https://github.com/JuliaLang/julia/search?q=PipeBuffer&ref=cmdform&type=Code

[Jameson Nash]

None of the names in IOBuffer are part of the API since they mean something slightly different from what you expect in almost all cases (especially .data and .ptr)

Use real(im) instead of im.re

Use takebuf_array(iob) instead of iob.data or use readbytes(iob)

[Uwe Fechner]

All of this is really missing in the documentation.

Is there a Julia documentation project?

It would be nice to have a wiki where people could add examples how to use the functions, provided
by Julia.

Regards:

Uwe

[Patrick O'Leary]

The documentation is in a series of ReStructured Text files in the main repository, under the `doc` directory: https://github.com/JuliaLang/julia/tree/master/doc

Pull requests to improve the documentation are very welcomed, and usually quickly accepted.