Struct SessionBuilder 

pub struct SessionBuilder { /* private fields */ }

Builder struct for creating a Session instance step-by-step.

The SessionBuilder allows you to configure and create a Session by specifying the necessary configuration and request handles.

Implementations

impl SessionBuilder

Builder for constructing a Session instance.

The SessionBuilder is used to incrementally construct a Session object, allowing for the configuration of various parameters before finalizing the session. It provides a flexible way to build and configure a Session by setting different attributes such as configuration, user-specific data, or other relevant parameters required for session management.

The builder pattern allows for creating a Session with multiple optional components in a controlled manner, without forcing users to provide all attributes at once.

Example:

let session = SessionBuilder::new()
    .with_config(config)
    .with_user_info(user_info)
    .build();

pub fn with_config(self, config: Config) -> Self

Sets the configuration for the session builder.

This method allows you to provide the configuration that will be used for the session.

Arguments

• config: The configuration to be used for the session.

Returns

The modified SessionBuilder instance with the specified configuration.

pub fn with_handles(self, handles: Handles) -> Self

Sets the handles for the session builder.

This method allows you to provide custom request handles that will be used for managing requests in the session.

Arguments

• handles: The handles to be used for managing requests.

Returns

The modified SessionBuilder instance with the specified handles.

pub fn build(self) -> Result<Session, Error>

Builds the final Session object.

This method checks if all required fields have been provided and creates the Session instance. If any required fields are missing, an error is returned.

Returns

• Ok(Session): The successfully built Session.
• Err(error::Error): An error if required fields are missing.