Skip to content

Commit e87b19b

Browse files
jw3126JeffBezanson
authored andcommitted
extend write docstring to mention Ref (#30677)
1 parent 17c4b02 commit e87b19b

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

base/io.jl

+13
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,19 @@ julia> write(io, "Sometimes those members") + write(io, " write documentation.")
176176
julia> String(take!(io))
177177
"Sometimes those members write documentation."
178178
```
179+
User-defined plain-data types without `write` methods can be written when wrapped in a `Ref`:
180+
```jldoctest
181+
julia> struct MyStruct; x::Float64; end
182+
183+
julia> io = IOBuffer()
184+
IOBuffer(data=UInt8[...], readable=true, writable=true, seekable=true, append=false, size=0, maxsize=Inf, ptr=1, mark=-1)
185+
186+
julia> write(io, Ref(MyStruct(42.0)))
187+
8
188+
189+
julia> seekstart(io); read!(io, Ref(MyStruct(NaN)))
190+
Base.RefValue{MyStruct}(MyStruct(42.0))
191+
```
179192
"""
180193
function write end
181194

0 commit comments

Comments
 (0)