pub struct Networks { /* private fields */ }Expand description
Interacting with network interfaces.
use sysinfo::Networks;
let networks = Networks::new_with_refreshed_list();
for (interface_name, network) in &networks {
println!("[{interface_name}]: {network:?}");
}Implementations§
Source§impl Networks
impl Networks
Sourcepub fn new() -> Self
pub fn new() -> Self
Creates a new empty Networks type.
If you want it to be filled directly, take a look at Networks::new_with_refreshed_list.
use sysinfo::Networks;
let mut networks = Networks::new();
networks.refresh(true);
for (interface_name, network) in &networks {
println!("[{interface_name}]: {network:?}");
}Sourcepub fn new_with_refreshed_list() -> Self
pub fn new_with_refreshed_list() -> Self
Creates a new Networks type with the network interfaces
list loaded.
use sysinfo::Networks;
let networks = Networks::new_with_refreshed_list();
for network in &networks {
println!("{network:?}");
}Examples found in repository?
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
fn main() {
println!("Getting system information...");
let mut system = System::new_all();
let mut networks = Networks::new_with_refreshed_list();
let mut disks = Disks::new_with_refreshed_list();
let mut components = Components::new_with_refreshed_list();
let mut users = Users::new_with_refreshed_list();
println!("Done.");
let t_stin = io::stdin();
let mut stin = t_stin.lock();
let mut done = false;
println!("To get the commands' list, enter 'help'.");
while !done {
let mut input = String::new();
write!(&mut io::stdout(), "> ");
io::stdout().flush();
stin.read_line(&mut input);
if input.is_empty() {
// The string is empty, meaning there is no '\n', meaning
// that the user used CTRL+D so we can just quit!
println!("\nLeaving, bye!");
break;
}
if (&input as &str).ends_with('\n') {
input.pop();
}
done = interpret_input(
input.as_ref(),
&mut system,
&mut networks,
&mut disks,
&mut components,
&mut users,
);
}
}Sourcepub fn list(&self) -> &HashMap<String, NetworkData>
pub fn list(&self) -> &HashMap<String, NetworkData>
Returns the network interfaces map.
use sysinfo::Networks;
let networks = Networks::new_with_refreshed_list();
for network in networks.list() {
println!("{network:?}");
}Sourcepub fn refresh(&mut self, remove_not_listed_interfaces: bool)
pub fn refresh(&mut self, remove_not_listed_interfaces: bool)
Refreshes the network interfaces.
use sysinfo::Networks;
let mut networks = Networks::new_with_refreshed_list();
// Wait some time...? Then refresh the data of each network.
networks.refresh(true);Examples found in repository?
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
fn interpret_input(
input: &str,
sys: &mut System,
networks: &mut Networks,
disks: &mut Disks,
components: &mut Components,
users: &mut Users,
) -> bool {
match input.trim() {
"help" => print_help(),
"refresh_disks" => {
writeln!(&mut io::stdout(), "Refreshing disk list...");
disks.refresh(true);
writeln!(&mut io::stdout(), "Done.");
}
"refresh_users" => {
writeln!(&mut io::stdout(), "Refreshing user list...");
users.refresh();
writeln!(&mut io::stdout(), "Done.");
}
"refresh_networks" => {
writeln!(&mut io::stdout(), "Refreshing network list...");
networks.refresh(true);
writeln!(&mut io::stdout(), "Done.");
}
"refresh_components" => {
writeln!(&mut io::stdout(), "Refreshing component list...");
components.refresh(true);
writeln!(&mut io::stdout(), "Done.");
}
"refresh_cpu" => {
writeln!(&mut io::stdout(), "Refreshing CPUs...");
sys.refresh_cpu_all();
writeln!(&mut io::stdout(), "Done.");
}
"signals" => {
let mut nb = 1i32;
for sig in signals {
writeln!(&mut io::stdout(), "{nb:2}:{sig:?}");
nb += 1;
}
}
"cpus" => {
// Note: you should refresh a few times before using this, so that usage statistics
// can be ascertained
writeln!(
&mut io::stdout(),
"number of physical cores: {}",
sys.physical_core_count()
.map(|c| c.to_string())
.unwrap_or_else(|| "Unknown".to_owned()),
);
writeln!(
&mut io::stdout(),
"total CPU usage: {}%",
sys.global_cpu_usage(),
);
for cpu in sys.cpus() {
writeln!(&mut io::stdout(), "{cpu:?}");
}
}
"memory" => {
writeln!(
&mut io::stdout(),
"total memory: {: >10} KB",
sys.total_memory() / 1_000
);
writeln!(
&mut io::stdout(),
"available memory: {: >10} KB",
sys.available_memory() / 1_000
);
writeln!(
&mut io::stdout(),
"used memory: {: >10} KB",
sys.used_memory() / 1_000
);
writeln!(
&mut io::stdout(),
"total swap: {: >10} KB",
sys.total_swap() / 1_000
);
writeln!(
&mut io::stdout(),
"used swap: {: >10} KB",
sys.used_swap() / 1_000
);
}
"quit" | "exit" => return true,
"all" => {
for (pid, proc_) in sys.processes() {
writeln!(
&mut io::stdout(),
"{}:{} status={:?}",
pid,
proc_.name().to_string_lossy(),
proc_.status()
);
}
}
"frequency" => {
for cpu in sys.cpus() {
writeln!(
&mut io::stdout(),
"[{}] {} MHz",
cpu.name(),
cpu.frequency(),
);
}
}
"vendor_id" => {
writeln!(
&mut io::stdout(),
"vendor ID: {}",
sys.cpus()[0].vendor_id()
);
}
"brand" => {
writeln!(&mut io::stdout(), "brand: {}", sys.cpus()[0].brand());
}
"load_avg" => {
let load_avg = System::load_average();
writeln!(&mut io::stdout(), "one minute : {}%", load_avg.one);
writeln!(&mut io::stdout(), "five minutes : {}%", load_avg.five);
writeln!(&mut io::stdout(), "fifteen minutes: {}%", load_avg.fifteen);
}
e if e.starts_with("show ") => {
let tmp: Vec<&str> = e.split(' ').collect();
if tmp.len() != 2 {
writeln!(
&mut io::stdout(),
"show command takes a pid or a name in parameter!"
);
writeln!(&mut io::stdout(), "example: show 1254");
} else if let Ok(pid) = Pid::from_str(tmp[1]) {
match sys.process(pid) {
Some(p) => writeln!(&mut io::stdout(), "{:?}", *p),
None => writeln!(&mut io::stdout(), "pid \"{pid:?}\" not found"),
};
} else {
let proc_name = tmp[1];
for proc_ in sys.processes_by_name(proc_name.as_ref()) {
writeln!(
&mut io::stdout(),
"==== {} ====",
proc_.name().to_string_lossy()
);
writeln!(&mut io::stdout(), "{proc_:?}");
}
}
}
"temperature" => {
for component in components.iter() {
writeln!(&mut io::stdout(), "{component:?}");
}
}
"network" => {
for (interface_name, data) in networks.iter() {
writeln!(
&mut io::stdout(),
"{}:\n ether {}\n input data (new / total): {} / {} B\n output data (new / total): {} / {} B",
interface_name,
data.mac_address(),
data.received(),
data.total_received(),
data.transmitted(),
data.total_transmitted(),
);
}
}
"show" => {
writeln!(
&mut io::stdout(),
"'show' command expects a pid number or a process name"
);
}
e if e.starts_with("kill ") => {
let tmp: Vec<&str> = e.split(' ').collect();
if tmp.len() != 3 {
writeln!(
&mut io::stdout(),
"kill command takes the pid and a signal number in parameter!"
);
writeln!(&mut io::stdout(), "example: kill 1254 9");
} else {
let pid = Pid::from_str(tmp[1]).unwrap();
let signal = i32::from_str(tmp[2]).unwrap();
if signal < 1 || signal > 31 {
writeln!(
&mut io::stdout(),
"Signal must be between 0 and 32 ! See the signals list with the \
signals command"
);
} else {
match sys.process(pid) {
Some(p) => {
if let Some(res) =
p.kill_with(*signals.get(signal as usize - 1).unwrap())
{
writeln!(&mut io::stdout(), "kill: {res}");
} else {
writeln!(
&mut io::stdout(),
"kill: signal not supported on this platform"
);
}
}
None => {
writeln!(&mut io::stdout(), "pid not found");
}
};
}
}
}
"disks" => {
for disk in disks {
writeln!(&mut io::stdout(), "{disk:?}");
}
}
"users" => {
for user in users {
writeln!(
&mut io::stdout(),
"{:?} => {:?}",
user.name(),
user.groups()
);
}
}
"boot_time" => {
writeln!(&mut io::stdout(), "{} seconds", System::boot_time());
}
"uptime" => {
let up = System::uptime();
let mut uptime = up;
let days = uptime / 86400;
uptime -= days * 86400;
let hours = uptime / 3600;
uptime -= hours * 3600;
let minutes = uptime / 60;
writeln!(
&mut io::stdout(),
"{days} days {hours} hours {minutes} minutes ({up} seconds in total)",
);
}
x if x.starts_with("refresh") => {
if x == "refresh" {
writeln!(&mut io::stdout(), "Getting processes' information...");
sys.refresh_all();
writeln!(&mut io::stdout(), "Done.");
} else if x.starts_with("refresh ") {
writeln!(&mut io::stdout(), "Getting process' information...");
if let Some(pid) = x
.split(' ')
.filter_map(|pid| pid.parse().ok())
.take(1)
.next()
{
if sys.refresh_processes(sysinfo::ProcessesToUpdate::Some(&[pid]), true) != 0 {
writeln!(&mut io::stdout(), "Process `{pid}` updated successfully");
} else {
writeln!(&mut io::stdout(), "Process `{pid}` couldn't be updated...");
}
} else {
writeln!(&mut io::stdout(), "Invalid [pid] received...");
}
} else {
writeln!(
&mut io::stdout(),
"\"{x}\": Unknown command. Enter 'help' if you want to get the commands' \
list.",
);
}
}
"pid" => {
writeln!(
&mut io::stdout(),
"PID: {}",
sysinfo::get_current_pid().expect("failed to get PID")
);
}
"system" => {
writeln!(
&mut io::stdout(),
"System name: {}\n\
System kernel version: {}\n\
System OS version: {}\n\
System OS (long) version: {}\n\
System host name: {}",
System::name().unwrap_or_else(|| "<unknown>".to_owned()),
System::kernel_version().unwrap_or_else(|| "<unknown>".to_owned()),
System::os_version().unwrap_or_else(|| "<unknown>".to_owned()),
System::long_os_version().unwrap_or_else(|| "<unknown>".to_owned()),
System::host_name().unwrap_or_else(|| "<unknown>".to_owned()),
);
}
e => {
writeln!(
&mut io::stdout(),
"\"{e}\": Unknown command. Enter 'help' if you want to get the commands' \
list.",
);
}
}
false
}Methods from Deref<Target = HashMap<String, NetworkData>>§
1.0.0pub fn capacity(&self) -> usize
pub fn capacity(&self) -> usize
Returns the number of elements the map can hold without reallocating.
This number is a lower bound; the HashMap<K, V> might be able to hold
more, but is guaranteed to be able to hold at least this many.
§Examples
use std::collections::HashMap;
let map: HashMap<i32, i32> = HashMap::with_capacity(100);
assert!(map.capacity() >= 100);1.0.0pub fn keys(&self) -> Keys<'_, K, V>
pub fn keys(&self) -> Keys<'_, K, V>
An iterator visiting all keys in arbitrary order.
The iterator element type is &'a K.
§Examples
use std::collections::HashMap;
let map = HashMap::from([
("a", 1),
("b", 2),
("c", 3),
]);
for key in map.keys() {
println!("{key}");
}§Performance
In the current implementation, iterating over keys takes O(capacity) time instead of O(len) because it internally visits empty buckets too.
1.0.0pub fn values(&self) -> Values<'_, K, V>
pub fn values(&self) -> Values<'_, K, V>
An iterator visiting all values in arbitrary order.
The iterator element type is &'a V.
§Examples
use std::collections::HashMap;
let map = HashMap::from([
("a", 1),
("b", 2),
("c", 3),
]);
for val in map.values() {
println!("{val}");
}§Performance
In the current implementation, iterating over values takes O(capacity) time instead of O(len) because it internally visits empty buckets too.
1.0.0pub fn iter(&self) -> Iter<'_, K, V>
pub fn iter(&self) -> Iter<'_, K, V>
An iterator visiting all key-value pairs in arbitrary order.
The iterator element type is (&'a K, &'a V).
§Examples
use std::collections::HashMap;
let map = HashMap::from([
("a", 1),
("b", 2),
("c", 3),
]);
for (key, val) in map.iter() {
println!("key: {key} val: {val}");
}§Performance
In the current implementation, iterating over map takes O(capacity) time instead of O(len) because it internally visits empty buckets too.
Examples found in repository?
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
fn interpret_input(
input: &str,
sys: &mut System,
networks: &mut Networks,
disks: &mut Disks,
components: &mut Components,
users: &mut Users,
) -> bool {
match input.trim() {
"help" => print_help(),
"refresh_disks" => {
writeln!(&mut io::stdout(), "Refreshing disk list...");
disks.refresh(true);
writeln!(&mut io::stdout(), "Done.");
}
"refresh_users" => {
writeln!(&mut io::stdout(), "Refreshing user list...");
users.refresh();
writeln!(&mut io::stdout(), "Done.");
}
"refresh_networks" => {
writeln!(&mut io::stdout(), "Refreshing network list...");
networks.refresh(true);
writeln!(&mut io::stdout(), "Done.");
}
"refresh_components" => {
writeln!(&mut io::stdout(), "Refreshing component list...");
components.refresh(true);
writeln!(&mut io::stdout(), "Done.");
}
"refresh_cpu" => {
writeln!(&mut io::stdout(), "Refreshing CPUs...");
sys.refresh_cpu_all();
writeln!(&mut io::stdout(), "Done.");
}
"signals" => {
let mut nb = 1i32;
for sig in signals {
writeln!(&mut io::stdout(), "{nb:2}:{sig:?}");
nb += 1;
}
}
"cpus" => {
// Note: you should refresh a few times before using this, so that usage statistics
// can be ascertained
writeln!(
&mut io::stdout(),
"number of physical cores: {}",
sys.physical_core_count()
.map(|c| c.to_string())
.unwrap_or_else(|| "Unknown".to_owned()),
);
writeln!(
&mut io::stdout(),
"total CPU usage: {}%",
sys.global_cpu_usage(),
);
for cpu in sys.cpus() {
writeln!(&mut io::stdout(), "{cpu:?}");
}
}
"memory" => {
writeln!(
&mut io::stdout(),
"total memory: {: >10} KB",
sys.total_memory() / 1_000
);
writeln!(
&mut io::stdout(),
"available memory: {: >10} KB",
sys.available_memory() / 1_000
);
writeln!(
&mut io::stdout(),
"used memory: {: >10} KB",
sys.used_memory() / 1_000
);
writeln!(
&mut io::stdout(),
"total swap: {: >10} KB",
sys.total_swap() / 1_000
);
writeln!(
&mut io::stdout(),
"used swap: {: >10} KB",
sys.used_swap() / 1_000
);
}
"quit" | "exit" => return true,
"all" => {
for (pid, proc_) in sys.processes() {
writeln!(
&mut io::stdout(),
"{}:{} status={:?}",
pid,
proc_.name().to_string_lossy(),
proc_.status()
);
}
}
"frequency" => {
for cpu in sys.cpus() {
writeln!(
&mut io::stdout(),
"[{}] {} MHz",
cpu.name(),
cpu.frequency(),
);
}
}
"vendor_id" => {
writeln!(
&mut io::stdout(),
"vendor ID: {}",
sys.cpus()[0].vendor_id()
);
}
"brand" => {
writeln!(&mut io::stdout(), "brand: {}", sys.cpus()[0].brand());
}
"load_avg" => {
let load_avg = System::load_average();
writeln!(&mut io::stdout(), "one minute : {}%", load_avg.one);
writeln!(&mut io::stdout(), "five minutes : {}%", load_avg.five);
writeln!(&mut io::stdout(), "fifteen minutes: {}%", load_avg.fifteen);
}
e if e.starts_with("show ") => {
let tmp: Vec<&str> = e.split(' ').collect();
if tmp.len() != 2 {
writeln!(
&mut io::stdout(),
"show command takes a pid or a name in parameter!"
);
writeln!(&mut io::stdout(), "example: show 1254");
} else if let Ok(pid) = Pid::from_str(tmp[1]) {
match sys.process(pid) {
Some(p) => writeln!(&mut io::stdout(), "{:?}", *p),
None => writeln!(&mut io::stdout(), "pid \"{pid:?}\" not found"),
};
} else {
let proc_name = tmp[1];
for proc_ in sys.processes_by_name(proc_name.as_ref()) {
writeln!(
&mut io::stdout(),
"==== {} ====",
proc_.name().to_string_lossy()
);
writeln!(&mut io::stdout(), "{proc_:?}");
}
}
}
"temperature" => {
for component in components.iter() {
writeln!(&mut io::stdout(), "{component:?}");
}
}
"network" => {
for (interface_name, data) in networks.iter() {
writeln!(
&mut io::stdout(),
"{}:\n ether {}\n input data (new / total): {} / {} B\n output data (new / total): {} / {} B",
interface_name,
data.mac_address(),
data.received(),
data.total_received(),
data.transmitted(),
data.total_transmitted(),
);
}
}
"show" => {
writeln!(
&mut io::stdout(),
"'show' command expects a pid number or a process name"
);
}
e if e.starts_with("kill ") => {
let tmp: Vec<&str> = e.split(' ').collect();
if tmp.len() != 3 {
writeln!(
&mut io::stdout(),
"kill command takes the pid and a signal number in parameter!"
);
writeln!(&mut io::stdout(), "example: kill 1254 9");
} else {
let pid = Pid::from_str(tmp[1]).unwrap();
let signal = i32::from_str(tmp[2]).unwrap();
if signal < 1 || signal > 31 {
writeln!(
&mut io::stdout(),
"Signal must be between 0 and 32 ! See the signals list with the \
signals command"
);
} else {
match sys.process(pid) {
Some(p) => {
if let Some(res) =
p.kill_with(*signals.get(signal as usize - 1).unwrap())
{
writeln!(&mut io::stdout(), "kill: {res}");
} else {
writeln!(
&mut io::stdout(),
"kill: signal not supported on this platform"
);
}
}
None => {
writeln!(&mut io::stdout(), "pid not found");
}
};
}
}
}
"disks" => {
for disk in disks {
writeln!(&mut io::stdout(), "{disk:?}");
}
}
"users" => {
for user in users {
writeln!(
&mut io::stdout(),
"{:?} => {:?}",
user.name(),
user.groups()
);
}
}
"boot_time" => {
writeln!(&mut io::stdout(), "{} seconds", System::boot_time());
}
"uptime" => {
let up = System::uptime();
let mut uptime = up;
let days = uptime / 86400;
uptime -= days * 86400;
let hours = uptime / 3600;
uptime -= hours * 3600;
let minutes = uptime / 60;
writeln!(
&mut io::stdout(),
"{days} days {hours} hours {minutes} minutes ({up} seconds in total)",
);
}
x if x.starts_with("refresh") => {
if x == "refresh" {
writeln!(&mut io::stdout(), "Getting processes' information...");
sys.refresh_all();
writeln!(&mut io::stdout(), "Done.");
} else if x.starts_with("refresh ") {
writeln!(&mut io::stdout(), "Getting process' information...");
if let Some(pid) = x
.split(' ')
.filter_map(|pid| pid.parse().ok())
.take(1)
.next()
{
if sys.refresh_processes(sysinfo::ProcessesToUpdate::Some(&[pid]), true) != 0 {
writeln!(&mut io::stdout(), "Process `{pid}` updated successfully");
} else {
writeln!(&mut io::stdout(), "Process `{pid}` couldn't be updated...");
}
} else {
writeln!(&mut io::stdout(), "Invalid [pid] received...");
}
} else {
writeln!(
&mut io::stdout(),
"\"{x}\": Unknown command. Enter 'help' if you want to get the commands' \
list.",
);
}
}
"pid" => {
writeln!(
&mut io::stdout(),
"PID: {}",
sysinfo::get_current_pid().expect("failed to get PID")
);
}
"system" => {
writeln!(
&mut io::stdout(),
"System name: {}\n\
System kernel version: {}\n\
System OS version: {}\n\
System OS (long) version: {}\n\
System host name: {}",
System::name().unwrap_or_else(|| "<unknown>".to_owned()),
System::kernel_version().unwrap_or_else(|| "<unknown>".to_owned()),
System::os_version().unwrap_or_else(|| "<unknown>".to_owned()),
System::long_os_version().unwrap_or_else(|| "<unknown>".to_owned()),
System::host_name().unwrap_or_else(|| "<unknown>".to_owned()),
);
}
e => {
writeln!(
&mut io::stdout(),
"\"{e}\": Unknown command. Enter 'help' if you want to get the commands' \
list.",
);
}
}
false
}1.0.0pub fn len(&self) -> usize
pub fn len(&self) -> usize
Returns the number of elements in the map.
§Examples
use std::collections::HashMap;
let mut a = HashMap::new();
assert_eq!(a.len(), 0);
a.insert(1, "a");
assert_eq!(a.len(), 1);1.0.0pub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
Returns true if the map contains no elements.
§Examples
use std::collections::HashMap;
let mut a = HashMap::new();
assert!(a.is_empty());
a.insert(1, "a");
assert!(!a.is_empty());1.9.0pub fn hasher(&self) -> &S
pub fn hasher(&self) -> &S
Returns a reference to the map’s [BuildHasher].
§Examples
use std::collections::HashMap;
use std::hash::RandomState;
let hasher = RandomState::new();
let map: HashMap<i32, i32> = HashMap::with_hasher(hasher);
let hasher: &RandomState = map.hasher();1.0.0pub fn get<Q>(&self, k: &Q) -> Option<&V>where
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,
pub fn get<Q>(&self, k: &Q) -> Option<&V>where
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,
Returns a reference to the value corresponding to the key.
The key may be any borrowed form of the map’s key type, but
[Hash] and [Eq] on the borrowed form must match those for
the key type.
§Examples
use std::collections::HashMap;
let mut map = HashMap::new();
map.insert(1, "a");
assert_eq!(map.get(&1), Some(&"a"));
assert_eq!(map.get(&2), None);1.40.0pub fn get_key_value<Q>(&self, k: &Q) -> Option<(&K, &V)>where
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,
pub fn get_key_value<Q>(&self, k: &Q) -> Option<(&K, &V)>where
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,
Returns the key-value pair corresponding to the supplied key. This is potentially useful:
- for key types where non-identical keys can be considered equal;
- for getting the
&Kstored key value from a borrowed&Qlookup key; or - for getting a reference to a key with the same lifetime as the collection.
The supplied key may be any borrowed form of the map’s key type, but
[Hash] and [Eq] on the borrowed form must match those for
the key type.
§Examples
use std::collections::HashMap;
use std::hash::{Hash, Hasher};
#[derive(Clone, Copy, Debug)]
struct S {
id: u32,
name: &'static str, // ignored by equality and hashing operations
}
impl PartialEq for S {
fn eq(&self, other: &S) -> bool {
self.id == other.id
}
}
impl Eq for S {}
impl Hash for S {
fn hash<H: Hasher>(&self, state: &mut H) {
self.id.hash(state);
}
}
let j_a = S { id: 1, name: "Jessica" };
let j_b = S { id: 1, name: "Jess" };
let p = S { id: 2, name: "Paul" };
assert_eq!(j_a, j_b);
let mut map = HashMap::new();
map.insert(j_a, "Paris");
assert_eq!(map.get_key_value(&j_a), Some((&j_a, &"Paris")));
assert_eq!(map.get_key_value(&j_b), Some((&j_a, &"Paris"))); // the notable case
assert_eq!(map.get_key_value(&p), None);1.0.0pub fn contains_key<Q>(&self, k: &Q) -> boolwhere
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,
pub fn contains_key<Q>(&self, k: &Q) -> boolwhere
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,
Returns true if the map contains a value for the specified key.
The key may be any borrowed form of the map’s key type, but
[Hash] and [Eq] on the borrowed form must match those for
the key type.
§Examples
use std::collections::HashMap;
let mut map = HashMap::new();
map.insert(1, "a");
assert_eq!(map.contains_key(&1), true);
assert_eq!(map.contains_key(&2), false);pub fn raw_entry(&self) -> RawEntryBuilder<'_, K, V, S>
🔬This is a nightly-only experimental API. (hash_raw_entry)
pub fn raw_entry(&self) -> RawEntryBuilder<'_, K, V, S>
hash_raw_entry)Creates a raw immutable entry builder for the HashMap.
Raw entries provide the lowest level of control for searching and manipulating a map. They must be manually initialized with a hash and then manually searched.
This is useful for
- Hash memoization
- Using a search key that doesn’t work with the Borrow trait
- Using custom comparison logic without newtype wrappers
Unless you are in such a situation, higher-level and more foolproof APIs like
get should be preferred.
Immutable raw entries have very limited use; you might instead want raw_entry_mut.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Networks
impl RefUnwindSafe for Networks
impl Send for Networks
impl Sync for Networks
impl Unpin for Networks
impl UnwindSafe for Networks
Blanket Implementations§
§impl<T> Any for Twhere
T: 'static + ?Sized,
impl<T> Any for Twhere
T: 'static + ?Sized,
§impl<T> Borrow<T> for Twhere
T: ?Sized,
impl<T> Borrow<T> for Twhere
T: ?Sized,
§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T, U> Into<U> for Twhere
U: From<T>,
impl<T, U> Into<U> for Twhere
U: From<T>,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where
F: FnOnce(&Self) -> bool,
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where
F: FnOnce(&Self) -> bool,
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more