var searchIndex = {};
searchIndex["scram"] = {"doc":"# Salted Challenge Response Authentication Mechanism (SCRAM)","items":[[3,"ClientFirst","scram","The initial state of the SCRAM mechanism. It's the entry point for a SCRAM handshake.",null,null],[3,"ServerFirst","","The second state of the SCRAM mechanism after the first client message was computed.",null,null],[3,"ClientFinal","","The third state of the SCRAM mechanism after the first server message was successfully\nprocessed.",null,null],[3,"ServerFinal","","The final state of the SCRAM mechanism after the final client message was computed.",null,null],[4,"Error","","The SCRAM mechanism error cases.",null,null],[13,"Protocol","","A message wasn't formatted as required. `Kind` contains further information.",0,null],[13,"UnsupportedExtension","","The server required a mandatory extension to be present that this client doesn't support.",0,null],[13,"InvalidServer","","The server couldn't be validated. This usually means that the server didn't posess a stored\nkey to verify the credentials.",0,null],[13,"Authentication","","The server rejected the authentication request. `String` contains a message from the server.",0,null],[4,"Kind","","The kinds of protocol errors.",null,null],[13,"InvalidNonce","","The server responded with a nonce that doesn't start with our nonce.",1,null],[13,"InvalidField","","The content of the field `Field` is invalid.",1,null],[13,"ExpectedField","","The field `Field` was expected but not found.",1,null],[4,"Field","","The fields used in the exchanged messages.",null,null],[13,"Nonce","","Nonce",2,null],[13,"Salt","","Salt",2,null],[13,"Iterations","","Iterations",2,null],[13,"VerifyOrError","","Verify or Error",2,null],[11,"fmt","","",0,null],[11,"fmt","","",1,null],[11,"fmt","","",2,null],[11,"fmt","","",0,null],[11,"description","","",0,null],[11,"fmt","","",3,null],[11,"new","","Constructs an initial state for the SCRAM mechanism using the provided credentials.",3,{"inputs":[{"name":"str"},{"name":"str"},{"name":"option"}],"output":{"name":"result"}}],[11,"with_rng","","Constructs an initial state for the SCRAM mechanism using the provided credentials and a\ncustom random number generator.",3,{"inputs":[{"name":"str"},{"name":"str"},{"name":"option"},{"name":"r"}],"output":{"name":"self"}}],[11,"client_first","","Returns the next state and the first client message.",3,null],[11,"fmt","","",4,null],[11,"handle_server_first","","Processes the first answer from the server and returns the next state or an error. If an\nerror is returned the SCRAM handshake is aborted.",4,null],[11,"fmt","","",5,null],[11,"client_final","","Returns the next state and the final client message.",5,null],[11,"fmt","","",6,null],[11,"handle_server_final","","Processes the final answer from the server and returns the authentication result.",6,null]],"paths":[[4,"Error"],[4,"Kind"],[4,"Field"],[3,"ClientFirst"],[3,"ServerFirst"],[3,"ClientFinal"],[3,"ServerFinal"]]};
initSearch(searchIndex);