Spear.scavenge_stream
You're seeing just the function
scavenge_stream
, go back to Spear module for more information.
Specs
scavenge_stream(scavenge :: String.t() | Spear.Scavenge.t()) :: String.t()
Produces the scavenge stream for a scavenge ID
start_scavenge/2
begins an asynchronous scavenge operation since scavenges
may be time consuming. In order to check the progress of a running scavenge,
one may read the scavenge stream with read_stream/3
or stream!/3
or
subscribe to updates on the scavenge with subscribe/4
.
Examples
iex> {:ok, scavenge} = Spear.start_scavenge(conn)
{:ok,
%Spear.Scavenge{id: "d2897ba8-2f0c-4fc4-bb25-798ba75f3562", result: :Started}}
iex> Spear.scavenge_stream(scavenge)
"$scavenges-d2897ba8-2f0c-4fc4-bb25-798ba75f3562"